icon
@@ -789,12 +796,16 @@
Table of contents
Properties
Properties
+accessibleNamespaces
+• Optional accessibleNamespaces: string[]
+
icon
• Optional icon: Object
Type declaration
diff --git a/master/search/search_index.json b/master/search/search_index.json
index f22f26b05f..52b0d10625 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 \u21b3\u21b3 GeneralCategory \u21b3\u21b3 WebLinkCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # (EventEmitter as new () => TypedEmitter).constructor Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string filters # \u2022 Protected filters : ObservableSet < AddMenuFilter > kind # \u2022 Readonly Abstract kind : string metadata # \u2022 Abstract metadata : Object Type declaration # Name Type icon string name string spec # \u2022 Abstract spec : CatalogCategorySpec Methods # addListener # \u25b8 addListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : 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 ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # (EventEmitter as new () => TypedEmitter).emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # (EventEmitter as new () => TypedEmitter).eventNames filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items getId # \u25b8 getId (): string Returns # string getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).listeners off # \u25b8 off ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).off on # \u25b8 on ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).on once # \u25b8 once ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).once prependListener # \u25b8 prependListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): CatalogCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): CatalogCategory Parameters # Name Type maxListeners number Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#class-catalogcategory","text":"Common . Catalog .CatalogCategory","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#hierarchy","text":"TypedEventEmitter < CatalogCategoryEvents , this> \u21b3 CatalogCategory \u21b3\u21b3 GeneralCategory \u21b3\u21b3 WebLinkCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#methods","text":"addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#constructor","text":"\u2022 new CatalogCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#filters","text":"\u2022 Protected filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#metadata","text":"\u2022 Abstract metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#spec","text":"\u2022 Abstract spec : CatalogCategorySpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#addlistener","text":"\u25b8 addListener ( 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 ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#off","text":"\u25b8 off ( event , listener ): CatalogCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#on","text":"\u25b8 on ( event , listener ): CatalogCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#once","text":"\u25b8 once ( event , listener ): CatalogCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): CatalogCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): CatalogCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): CatalogCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): CatalogCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): CatalogCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.catalogcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/common.catalog.catalogentity/","text":"Class: CatalogEntity # Common . Catalog .CatalogEntity Type parameters # Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec Hierarchy # CatalogEntity \u21b3 GeneralEntity \u21b3 KubernetesCluster \u21b3 WebLink Implements # CatalogEntityKindData Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity ( data ) Type parameters # Name Type Metadata Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec Parameters # Name Type data CatalogEntityData Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Returns # string getName # \u25b8 getName (): string Returns # string onContextMenuOpen # \u25b8 Abstract onContextMenuOpen ( context ): void | Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise onRun # \u25b8 Optional Abstract onRun ( context ): void | Promise Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise onSettingsOpen # \u25b8 Abstract onSettingsOpen ( context ): void | Promise Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise ","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 Metadata : CatalogEntityMetadata = CatalogEntityMetadata Status Status : CatalogEntityStatus = CatalogEntityStatus Spec Spec : CatalogEntitySpec = CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/classes/common.catalog.catalogentity/#hierarchy","text":"CatalogEntity \u21b3 GeneralEntity \u21b3 KubernetesCluster \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.catalogentity/#implements","text":"CatalogEntityKindData","title":"Implements"},{"location":"extensions/api/classes/common.catalog.catalogentity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogentity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogentity/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.catalogentity/#constructor","text":"\u2022 new CatalogEntity ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.catalogentity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.catalogentity/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.catalogentity/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/common.catalog.catalogentity/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.catalogentity/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/common.catalog.catalogentity/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/common.catalog.catalogentity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.catalogentity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.catalogentity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.catalogentity/#oncontextmenuopen","text":"\u25b8 Abstract onContextMenuOpen ( context ): void | Promise ","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.catalogentity/#onrun","text":"\u25b8 Optional Abstract onRun ( context ): void | Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.catalogentity/#onsettingsopen","text":"\u25b8 Abstract onSettingsOpen ( context ): void | Promise ","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.generalcategory/","text":"Class: GeneralCategory # Common . Catalog .GeneralCategory Hierarchy # CatalogCategory \u21b3 GeneralCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new GeneralCategory () Inherited from # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion filters # \u2022 Protected filters : ObservableSet < AddMenuFilter > Inherited from # CatalogCategory . filters kind # \u2022 Readonly kind : \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : Object Type declaration # Name Type group string names Object names.kind string versions { entityClass : typeof GeneralEntity ; name : string = \"v1alpha1\" }[] Overrides # CatalogCategory . spec Methods # addListener # \u25b8 addListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . 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 Inherited from # CatalogCategory . addMenuFilter emit # \u25b8 emit ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # CatalogCategory . emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # CatalogCategory . 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 Inherited from # CatalogCategory . filteredItems getId # \u25b8 getId (): string Returns # string Inherited from # CatalogCategory . getId getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # CatalogCategory . getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # CatalogCategory . listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . listeners off # \u25b8 off ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . off on # \u25b8 on ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . on once # \u25b8 once ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . once prependListener # \u25b8 prependListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # GeneralCategory Inherited from # CatalogCategory . removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): GeneralCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # GeneralCategory Inherited from # CatalogCategory . removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): GeneralCategory Parameters # Name Type maxListeners number Returns # GeneralCategory Inherited from # CatalogCategory . setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: GeneralCategory"},{"location":"extensions/api/classes/common.catalog.generalcategory/#class-generalcategory","text":"Common . Catalog .GeneralCategory","title":"Class: GeneralCategory"},{"location":"extensions/api/classes/common.catalog.generalcategory/#hierarchy","text":"CatalogCategory \u21b3 GeneralCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.generalcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalcategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalcategory/#methods","text":"addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalcategory/#constructor","text":"\u2022 new GeneralCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.generalcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalcategory/#apiversion","text":"\u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.generalcategory/#filters","text":"\u2022 Protected filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/common.catalog.generalcategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.generalcategory/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.generalcategory/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/common.catalog.generalcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalcategory/#addlistener","text":"\u25b8 addListener ( event , listener ): GeneralCategory","title":"addListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/common.catalog.generalcategory/#emit","text":"\u25b8 emit ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.generalcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.generalcategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/common.catalog.generalcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.generalcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.generalcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#off","text":"\u25b8 off ( event , listener ): GeneralCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.generalcategory/#on","text":"\u25b8 on ( event , listener ): GeneralCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.generalcategory/#once","text":"\u25b8 once ( event , listener ): GeneralCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.generalcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): GeneralCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): GeneralCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): GeneralCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): GeneralCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.generalcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): GeneralCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.generalcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"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 onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec> Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : GeneralEntitySpec Inherited from # CatalogEntity . spec status # \u2022 status : CatalogEntityStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen (): void Returns # void Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun (): Promise Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/common.catalog.generalentity/#class-generalentity","text":"Common . Catalog .GeneralEntity","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/common.catalog.generalentity/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec> \u21b3 GeneralEntity","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.generalentity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalentity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalentity/#methods","text":"getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.generalentity/#constructor","text":"\u2022 new GeneralEntity ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.generalentity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.generalentity/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.generalentity/#kind","text":"\u2022 Readonly kind : \"General\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.generalentity/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.generalentity/#spec","text":"\u2022 spec : GeneralEntitySpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.generalentity/#status","text":"\u2022 status : CatalogEntityStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.generalentity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.generalentity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.generalentity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.generalentity/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen (): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.generalentity/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/common.catalog.generalentity/#onrun","text":"\u25b8 onRun (): Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.generalentity/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Hierarchy # CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster ( data ) Parameters # Name Type data CatalogEntityData < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"KubernetesCluster\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : KubernetesClusterMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : KubernetesClusterSpec Inherited from # CatalogEntity . spec status # \u2022 status : KubernetesClusterStatus Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"KubernetesCluster\" Methods # connect # \u25b8 connect (): Promise Returns # Promise disconnect # \u25b8 disconnect (): Promise Returns # Promise getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun ( context ): Promise Parameters # Name Type context CatalogEntityActionContext Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#class-kubernetescluster","text":"Common . Catalog .KubernetesCluster","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#hierarchy","text":"CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#methods","text":"connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#constructor","text":"\u2022 new KubernetesCluster ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#kind","text":"\u2022 Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#metadata","text":"\u2022 metadata : KubernetesClusterMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#spec","text":"\u2022 spec : KubernetesClusterSpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#status","text":"\u2022 status : KubernetesClusterStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#kind_1","text":"\u25aa Static Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#connect","text":"\u25b8 connect (): Promise ","title":"connect"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#disconnect","text":"\u25b8 disconnect (): Promise ","title":"disconnect"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.kubernetescluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise ","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 ","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 Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : WebLinkSpec Inherited from # CatalogEntity . spec status # \u2022 status : WebLinkStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise Returns # Promise Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/common.catalog.weblink/#class-weblink","text":"Common . Catalog .WebLink","title":"Class: WebLink"},{"location":"extensions/api/classes/common.catalog.weblink/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.weblink/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.weblink/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblink/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblink/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblink/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblink/#constructor","text":"\u2022 new WebLink ( data )","title":"constructor"},{"location":"extensions/api/classes/common.catalog.weblink/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblink/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.weblink/#kind","text":"\u2022 Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.weblink/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/common.catalog.weblink/#spec","text":"\u2022 spec : WebLinkSpec","title":"spec"},{"location":"extensions/api/classes/common.catalog.weblink/#status","text":"\u2022 status : WebLinkStatus","title":"status"},{"location":"extensions/api/classes/common.catalog.weblink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblink/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.weblink/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/common.catalog.weblink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise ","title":"onContextMenuOpen"},{"location":"extensions/api/classes/common.catalog.weblink/#onrun","text":"\u25b8 onRun (): Promise ","title":"onRun"},{"location":"extensions/api/classes/common.catalog.weblink/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/","text":"Class: WebLinkCategory # Common . Catalog .WebLinkCategory Hierarchy # CatalogCategory \u21b3 WebLinkCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec onAdd Methods # addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new WebLinkCategory () Overrides # CatalogCategory . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\" Overrides # CatalogCategory . apiVersion filters # \u2022 Protected filters : ObservableSet < AddMenuFilter > Inherited from # CatalogCategory . filters kind # \u2022 Readonly kind : \"CatalogCategory\" Overrides # CatalogCategory . kind metadata # \u2022 metadata : Object Type declaration # Name Type icon string name string Overrides # CatalogCategory . metadata spec # \u2022 spec : Object Type declaration # Name Type group string names Object names.kind string versions { entityClass : typeof WebLink ; name : string = \"v1alpha1\" }[] Overrides # CatalogCategory . spec onAdd # \u25aa Static Optional onAdd : () => void Type declaration # \u25b8 (): void Returns # void Methods # addListener # \u25b8 addListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . 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 Inherited from # CatalogCategory . addMenuFilter emit # \u25b8 emit ( event , ... args ): boolean Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # CatalogCategory . emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # CatalogCategory . 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 Inherited from # CatalogCategory . filteredItems getId # \u25b8 getId (): string Returns # string Inherited from # CatalogCategory . getId getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # CatalogCategory . getMaxListeners listenerCount # \u25b8 listenerCount ( event ): number Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # CatalogCategory . listenerCount listeners # \u25b8 listeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . listeners off # \u25b8 off ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . off on # \u25b8 on ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . on once # \u25b8 once ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . once prependListener # \u25b8 prependListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . prependListener prependOnceListener # \u25b8 prependOnceListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . prependOnceListener rawListeners # \u25b8 rawListeners ( event ): Function [] Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # CatalogCategory . rawListeners removeAllListeners # \u25b8 removeAllListeners ( event? ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # WebLinkCategory Inherited from # CatalogCategory . removeAllListeners removeListener # \u25b8 removeListener ( event , listener ): WebLinkCategory Type parameters # Name Type E E : keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # WebLinkCategory Inherited from # CatalogCategory . removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): WebLinkCategory Parameters # Name Type maxListeners number Returns # WebLinkCategory Inherited from # CatalogCategory . setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string Inherited from # CatalogCategory . parseId","title":"Class: WebLinkCategory"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#class-weblinkcategory","text":"Common . Catalog .WebLinkCategory","title":"Class: WebLinkCategory"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#hierarchy","text":"CatalogCategory \u21b3 WebLinkCategory","title":"Hierarchy"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#properties","text":"apiVersion filters kind metadata spec onAdd","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#methods","text":"addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#constructor","text":"\u2022 new WebLinkCategory ()","title":"constructor"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#apiversion","text":"\u2022 Readonly apiVersion : \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#filters","text":"\u2022 Protected filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#kind","text":"\u2022 Readonly kind : \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#metadata","text":"\u2022 metadata : Object","title":"metadata"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#onadd","text":"\u25aa Static Optional onAdd : () => void","title":"onAdd"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#addlistener","text":"\u25b8 addListener ( event , listener ): WebLinkCategory","title":"addListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#emit","text":"\u25b8 emit ( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#listenercount","text":"\u25b8 listenerCount ( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#listeners","text":"\u25b8 listeners ( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#off","text":"\u25b8 off ( event , listener ): WebLinkCategory","title":"off"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#on","text":"\u25b8 on ( event , listener ): WebLinkCategory","title":"on"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#once","text":"\u25b8 once ( event , listener ): WebLinkCategory","title":"once"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#prependlistener","text":"\u25b8 prependListener ( event , listener ): WebLinkCategory","title":"prependListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#prependoncelistener","text":"\u25b8 prependOnceListener ( event , listener ): WebLinkCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#rawlisteners","text":"\u25b8 rawListeners ( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#removealllisteners","text":"\u25b8 removeAllListeners ( event? ): WebLinkCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#removelistener","text":"\u25b8 removeListener ( event , listener ): WebLinkCategory","title":"removeListener"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): WebLinkCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/common.catalog.weblinkcategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/common.store.extensionstore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Type parameters # Name T Hierarchy # BaseStore \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # extension params storeConfig syncDisposers Accessors # name path syncMainChannel syncRendererChannel Methods # applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance Constructors # constructor # \u2022 Protected new ExtensionStore ( params ) Type parameters # Name T Parameters # Name Type params BaseStoreParams Inherited from # BaseStore.constructor Properties # extension # \u2022 Protected extension : LensExtension params # \u2022 Protected params : BaseStoreParams Inherited from # BaseStore.params storeConfig # \u2022 Protected Optional storeConfig : Conf Inherited from # BaseStore.storeConfig syncDisposers # \u2022 Protected syncDisposers : Disposer [] = [] Inherited from # BaseStore.syncDisposers Accessors # name # \u2022 get name (): string Returns # string path # \u2022 get path (): string Returns # string syncMainChannel # \u2022 Protected get syncMainChannel (): string Returns # string syncRendererChannel # \u2022 Protected get syncRendererChannel (): string Returns # string Methods # applyWithoutSync # \u25b8 Protected applyWithoutSync ( callback ): void Parameters # Name Type callback () => void Returns # void Inherited from # BaseStore.applyWithoutSync cwd # \u25b8 Protected cwd (): string Returns # string Overrides # BaseStore.cwd disableSync # \u25b8 disableSync (): void Returns # void Inherited from # BaseStore.disableSync enableSync # \u25b8 enableSync (): void Returns # void Inherited from # BaseStore.enableSync fromStore # \u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous. Parameters # Name Type Description data T the parsed information read from the stored JSON file Returns # void Inherited from # BaseStore.fromStore load # \u25b8 load (): void Returns # void Overrides # BaseStore.load loadExtension # \u25b8 loadExtension ( extension ): void Parameters # Name Type extension LensExtension Returns # void onModelChange # \u25b8 Protected onModelChange ( model ): Promise Parameters # Name Type model T Returns # Promise Inherited from # BaseStore.onModelChange onSync # \u25b8 Protected onSync ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSync onSyncFromMain # \u25b8 Protected onSyncFromMain ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSyncFromMain saveToFile # \u25b8 Protected saveToFile ( model ): Promise Parameters # Name Type model T Returns # Promise 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 (... 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 R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # BaseStore.createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # BaseStore.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # BaseStore.resetInstance","title":"Class: ExtensionStore"},{"location":"extensions/api/classes/common.store.extensionstore/#class-extensionstoret","text":"Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: ExtensionStore<T>"},{"location":"extensions/api/classes/common.store.extensionstore/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/classes/common.store.extensionstore/#hierarchy","text":"BaseStore \u21b3 ExtensionStore","title":"Hierarchy"},{"location":"extensions/api/classes/common.store.extensionstore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.store.extensionstore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.store.extensionstore/#properties","text":"extension params storeConfig syncDisposers","title":"Properties"},{"location":"extensions/api/classes/common.store.extensionstore/#accessors","text":"name path syncMainChannel syncRendererChannel","title":"Accessors"},{"location":"extensions/api/classes/common.store.extensionstore/#methods","text":"applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/common.store.extensionstore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.store.extensionstore/#constructor","text":"\u2022 Protected new ExtensionStore ( params )","title":"constructor"},{"location":"extensions/api/classes/common.store.extensionstore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/common.store.extensionstore/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/common.store.extensionstore/#params","text":"\u2022 Protected params : BaseStoreParams ","title":"params"},{"location":"extensions/api/classes/common.store.extensionstore/#storeconfig","text":"\u2022 Protected Optional storeConfig : Conf ","title":"storeConfig"},{"location":"extensions/api/classes/common.store.extensionstore/#syncdisposers","text":"\u2022 Protected syncDisposers : Disposer [] = []","title":"syncDisposers"},{"location":"extensions/api/classes/common.store.extensionstore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/common.store.extensionstore/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/common.store.extensionstore/#path","text":"\u2022 get path (): string","title":"path"},{"location":"extensions/api/classes/common.store.extensionstore/#syncmainchannel","text":"\u2022 Protected get syncMainChannel (): string","title":"syncMainChannel"},{"location":"extensions/api/classes/common.store.extensionstore/#syncrendererchannel","text":"\u2022 Protected get syncRendererChannel (): string","title":"syncRendererChannel"},{"location":"extensions/api/classes/common.store.extensionstore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.store.extensionstore/#applywithoutsync","text":"\u25b8 Protected applyWithoutSync ( callback ): void","title":"applyWithoutSync"},{"location":"extensions/api/classes/common.store.extensionstore/#cwd","text":"\u25b8 Protected cwd (): string","title":"cwd"},{"location":"extensions/api/classes/common.store.extensionstore/#disablesync","text":"\u25b8 disableSync (): void","title":"disableSync"},{"location":"extensions/api/classes/common.store.extensionstore/#enablesync","text":"\u25b8 enableSync (): void","title":"enableSync"},{"location":"extensions/api/classes/common.store.extensionstore/#fromstore","text":"\u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous.","title":"fromStore"},{"location":"extensions/api/classes/common.store.extensionstore/#load","text":"\u25b8 load (): void","title":"load"},{"location":"extensions/api/classes/common.store.extensionstore/#loadextension","text":"\u25b8 loadExtension ( extension ): void","title":"loadExtension"},{"location":"extensions/api/classes/common.store.extensionstore/#onmodelchange","text":"\u25b8 Protected onModelChange ( model ): Promise ","title":"onModelChange"},{"location":"extensions/api/classes/common.store.extensionstore/#onsync","text":"\u25b8 Protected onSync ( model ): void","title":"onSync"},{"location":"extensions/api/classes/common.store.extensionstore/#onsyncfrommain","text":"\u25b8 Protected onSyncFromMain ( model ): void","title":"onSyncFromMain"},{"location":"extensions/api/classes/common.store.extensionstore/#savetofile","text":"\u25b8 Protected saveToFile ( model ): Promise ","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 (... 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 ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/common.store.extensionstore/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/common.util.singleton/","text":"Class: Singleton # Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # Singleton \u21b3 TerminalStore Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \u25b8 Static createInstance (... 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 R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void","title":"Class: Singleton"},{"location":"extensions/api/classes/common.util.singleton/#class-singleton","text":"Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: Singleton"},{"location":"extensions/api/classes/common.util.singleton/#hierarchy","text":"Singleton \u21b3 TerminalStore","title":"Hierarchy"},{"location":"extensions/api/classes/common.util.singleton/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/common.util.singleton/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/common.util.singleton/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/common.util.singleton/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/common.util.singleton/#constructor","text":"\u2022 new Singleton ()","title":"constructor"},{"location":"extensions/api/classes/common.util.singleton/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/common.util.singleton/#createinstance","text":"\u25b8 Static createInstance (... 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 ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/common.util.singleton/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/","text":"Class: CatalogEntityRegistry # Main . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Methods # getItemsForApiKind Constructors # constructor # \u2022 new CatalogEntityRegistry () Methods # getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): T [] Type parameters # Name Type T T : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T> Parameters # Name Type apiVersion string kind string Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#class-catalogentityregistry","text":"Main . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#methods","text":"getItemsForApiKind","title":"Methods"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.catalog.catalogentityregistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/main.ipc/","text":"Class: Ipc # Main .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast handle listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@44027 extension # \u2022 Protected extension : LensExtension Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ... args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast handle # \u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled Parameters # Name Type Description channel string The name of the RPC handler ( event : IpcMainInvokeEvent , ... args : any []) => any The remote procedure that is called Returns # void listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension Parameters # Name Type Description channel string The channel to listen for broadcasts on listener ( event : IpcRendererEvent , ... args : any []) => any The function that will be called with the arguments of the broadcast Returns # Disposer An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called createInstance # \u25b8 Static createInstance (... 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 R : any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance ( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R R : any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/main.ipc/#class-ipc","text":"Main .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/main.ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/main.ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/main.ipc/#methods","text":"broadcast handle listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/main.ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/main.ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/main.ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/main.ipc/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/main.ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.ipc/#broadcast","text":"\u25b8 broadcast ( channel , ... args ): void","title":"broadcast"},{"location":"extensions/api/classes/main.ipc/#handle","text":"\u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled","title":"handle"},{"location":"extensions/api/classes/main.ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension","title":"listen"},{"location":"extensions/api/classes/main.ipc/#createinstance","text":"\u25b8 Static createInstance (... 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 ( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/main.ipc/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/main.lensextension/","text":"Class: LensExtension # Main .LensExtension Hierarchy # LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # [Disposers] appMenus id isBundled manifest manifestPath protocolHandlers Accessors # description name version Methods # addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource Constructors # constructor # \u2022 new LensExtension ( __namedParameters ) Parameters # Name Type __namedParameters InstalledExtension Inherited from # LensExtension.constructor Properties # [Disposers] # \u2022 [Disposers] : ExtendableDisposer Inherited from # LensExtension.__@Disposers@31476 appMenus # \u2022 appMenus : MenuRegistration [] = [] id # \u2022 Readonly id : string Inherited from # LensExtension.id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension.isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension.manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension.manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] = [] Inherited from # LensExtension.protocolHandlers Accessors # description # \u2022 get description (): string Returns # string name # \u2022 get name (): string Returns # string version # \u2022 get version (): string Returns # string Methods # addCatalogSource # \u25b8 addCatalogSource ( id , source ): void Parameters # Name Type id string source IObservableArray < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # void disable # \u25b8 disable (): Promise Returns # Promise Inherited from # LensExtension.disable enable # \u25b8 enable ( register ): Promise Parameters # Name Type register ( ext : LensExtension ) => Promise Returns # Promise Inherited from # LensExtension.enable getExtensionFileFolder # \u25b8 getExtensionFileFolder (): Promise 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 Inherited from # LensExtension.getExtensionFileFolder navigate # \u25b8 navigate ( pageId? , params? , frameId? ): Promise Parameters # Name Type pageId? string params? Record frameId? number Returns # Promise onActivate # \u25b8 Protected onActivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise Returns # void | Promise Inherited from # LensExtension.onDeactivate removeCatalogSource # \u25b8 removeCatalogSource ( id ): void Parameters # Name Type id string Returns # void","title":"Class: LensExtension"},{"location":"extensions/api/classes/main.lensextension/#class-lensextension","text":"Main .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/main.lensextension/#hierarchy","text":"LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/main.lensextension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/main.lensextension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/main.lensextension/#properties","text":"[Disposers] appMenus id isBundled manifest manifestPath protocolHandlers","title":"Properties"},{"location":"extensions/api/classes/main.lensextension/#accessors","text":"description name version","title":"Accessors"},{"location":"extensions/api/classes/main.lensextension/#methods","text":"addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource","title":"Methods"},{"location":"extensions/api/classes/main.lensextension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/main.lensextension/#constructor","text":"\u2022 new LensExtension ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/main.lensextension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/main.lensextension/#disposers","text":"\u2022 [Disposers] : ExtendableDisposer","title":"[Disposers]"},{"location":"extensions/api/classes/main.lensextension/#appmenus","text":"\u2022 appMenus : MenuRegistration [] = []","title":"appMenus"},{"location":"extensions/api/classes/main.lensextension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/main.lensextension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/main.lensextension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/main.lensextension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/main.lensextension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration [] = []","title":"protocolHandlers"},{"location":"extensions/api/classes/main.lensextension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/main.lensextension/#description","text":"\u2022 get description (): string","title":"description"},{"location":"extensions/api/classes/main.lensextension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/main.lensextension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/main.lensextension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/main.lensextension/#addcatalogsource","text":"\u25b8 addCatalogSource ( id , source ): void","title":"addCatalogSource"},{"location":"extensions/api/classes/main.lensextension/#disable","text":"\u25b8 disable (): Promise ","title":"disable"},{"location":"extensions/api/classes/main.lensextension/#enable","text":"\u25b8 enable ( register ): Promise ","title":"enable"},{"location":"extensions/api/classes/main.lensextension/#getextensionfilefolder","text":"\u25b8 getExtensionFileFolder (): Promise 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 ","title":"navigate"},{"location":"extensions/api/classes/main.lensextension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise ","title":"onActivate"},{"location":"extensions/api/classes/main.lensextension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise ","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 # getById getItemsForApiKind getItemsForCategory Constructors # constructor # \u2022 new CatalogEntityRegistry () Accessors # activeEntity # \u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > entities # \u2022 get entities (): Map > Returns # Map > Methods # getById # \u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > getItemsForApiKind # \u25b8 getItemsForApiKind ( apiVersion , kind ): T [] Type parameters # Name Type T T : CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T> Parameters # Name Type apiVersion string kind string Returns # T [] getItemsForCategory # \u25b8 getItemsForCategory ( category ): T [] Type parameters # Name Type T T : 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":"getById getItemsForApiKind getItemsForCategory","title":"Methods"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#activeentity","text":"\u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity","title":"activeEntity"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#entities","text":"\u2022 get entities (): Map >","title":"entities"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getbyid","text":"\u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"getById"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind ( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/renderer.catalog.catalogentityregistry/#getitemsforcategory","text":"\u25b8 getItemsForCategory ( category ): T []","title":"getItemsForCategory"},{"location":"extensions/api/classes/renderer.component.badge/","text":"Class: Badge # Renderer . Component .Badge Hierarchy # Component < BadgeProps > \u21b3 Badge Table of contents # Constructors # constructor Properties # context elem isExpanded props refs state badgeMeta contextType defaultProps Accessors # isExpandable Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate Constructors # constructor # \u2022 new Badge ( props ) Parameters # Name Type props BadgeProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context elem # \u2022 elem : HTMLElement isExpanded # \u2022 isExpanded : boolean = false props # \u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state badgeMeta # \u25aa Static badgeMeta : Object Type declaration # Name Type hasTextSelected boolean contextType # \u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : Partial < BadgeProps > Accessors # isExpandable # \u2022 get isExpandable (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onMouseUp # \u25b8 onMouseUp (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < BadgeProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Badge"},{"location":"extensions/api/classes/renderer.component.badge/#class-badge","text":"Renderer . Component .Badge","title":"Class: Badge"},{"location":"extensions/api/classes/renderer.component.badge/#hierarchy","text":"Component < BadgeProps > \u21b3 Badge","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.badge/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.badge/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.badge/#properties","text":"context elem isExpanded props refs state badgeMeta contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.badge/#accessors","text":"isExpandable","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.badge/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.badge/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.badge/#constructor","text":"\u2022 new Badge ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.badge/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.badge/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/renderer.component.badge/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/renderer.component.badge/#isexpanded","text":"\u2022 isExpanded : boolean = false","title":"isExpanded"},{"location":"extensions/api/classes/renderer.component.badge/#props","text":"\u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.badge/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.badge/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.badge/#badgemeta","text":"\u25aa Static badgeMeta : Object","title":"badgeMeta"},{"location":"extensions/api/classes/renderer.component.badge/#contexttype","text":"\u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/renderer.component.badge/#defaultprops","text":"\u25aa Static defaultProps : Partial < BadgeProps >","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.badge/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.badge/#isexpandable","text":"\u2022 get isExpandable (): boolean","title":"isExpandable"},{"location":"extensions/api/classes/renderer.component.badge/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.badge/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.badge/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.badge/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.badge/#onmouseup","text":"\u25b8 onMouseUp (): void","title":"onMouseUp"},{"location":"extensions/api/classes/renderer.component.badge/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.badge/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.badge/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/","text":"Class: BarChart # Renderer . Component .BarChart Hierarchy # Component \u21b3 BarChart Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new BarChart ( props ) Parameters # Name Type props Props | Readonly Inherited from # React.Component.constructor \u2022 new BarChart ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly ) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: BarChart"},{"location":"extensions/api/classes/renderer.component.barchart/#class-barchart","text":"Renderer . Component .BarChart","title":"Class: BarChart"},{"location":"extensions/api/classes/renderer.component.barchart/#hierarchy","text":"Component \u21b3 BarChart","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.barchart/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.barchart/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.barchart/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/renderer.component.barchart/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.barchart/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.barchart/#constructor","text":"\u2022 new BarChart ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.barchart/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.barchart/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/renderer.component.barchart/#props","text":"\u2022 Readonly props : Readonly & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.barchart/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.barchart/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.barchart/#contexttype","text":"\u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/renderer.component.barchart/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/renderer.component.barchart/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.barchart/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.barchart/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.barchart/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.barchart/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.barchart/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.button/","text":"Class: Button # Renderer . Component .Button Hierarchy # PureComponent < ButtonProps , Object > \u21b3 Button Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Button ( props ) Parameters # Name Type props ButtonProps | Readonly < ButtonProps > Inherited from # React.PureComponent.constructor \u2022 new Button ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props ButtonProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ButtonProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Button"},{"location":"extensions/api/classes/renderer.component.button/#class-button","text":"Renderer . Component .Button","title":"Class: Button"},{"location":"extensions/api/classes/renderer.component.button/#hierarchy","text":"PureComponent < ButtonProps , Object > \u21b3 Button","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.button/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.button/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.button/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.button/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.button/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.button/#constructor","text":"\u2022 new Button ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.button/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.button/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/renderer.component.button/#props","text":"\u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.button/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.button/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.button/#contexttype","text":"\u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/renderer.component.button/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.button/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.button/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.button/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.button/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.button/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.button/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.button/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.button/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.button/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.button/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.button/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.button/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.button/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/","text":"Class: Checkbox # Renderer . Component .Checkbox Hierarchy # PureComponent < CheckboxProps > \u21b3 Checkbox Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate Constructors # constructor # \u2022 new Checkbox ( props ) Parameters # Name Type props CheckboxProps | Readonly < CheckboxProps > Inherited from # React.PureComponent.constructor \u2022 new Checkbox ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props CheckboxProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < CheckboxProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < CheckboxProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < CheckboxProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate getValue # \u25b8 getValue (): boolean Returns # boolean onChange # \u25b8 onChange ( evt ): void Parameters # Name Type evt ChangeEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < CheckboxProps \\>) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < CheckboxProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Checkbox"},{"location":"extensions/api/classes/renderer.component.checkbox/#class-checkbox","text":"Renderer . Component .Checkbox","title":"Class: Checkbox"},{"location":"extensions/api/classes/renderer.component.checkbox/#hierarchy","text":"PureComponent < CheckboxProps > \u21b3 Checkbox","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.checkbox/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.checkbox/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/renderer.component.checkbox/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.checkbox/#constructor","text":"\u2022 new Checkbox ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.checkbox/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.checkbox/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/renderer.component.checkbox/#props","text":"\u2022 Readonly props : Readonly < CheckboxProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.checkbox/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.checkbox/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.checkbox/#contexttype","text":"\u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/renderer.component.checkbox/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.checkbox/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.checkbox/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.checkbox/#getvalue","text":"\u25b8 getValue (): boolean","title":"getValue"},{"location":"extensions/api/classes/renderer.component.checkbox/#onchange","text":"\u25b8 onChange ( evt ): void","title":"onChange"},{"location":"extensions/api/classes/renderer.component.checkbox/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.checkbox/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.checkbox/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.commandoverlay/","text":"Class: CommandOverlay # Renderer . Component .CommandOverlay Table of contents # Constructors # constructor Accessors # component isOpen Methods # close open Constructors # constructor # \u2022 new CommandOverlay () Accessors # component # \u2022 Static get component (): ReactElement > Returns # ReactElement > isOpen # \u2022 Static get isOpen (): boolean Returns # boolean Methods # close # \u25b8 Static close (): void Returns # void open # \u25b8 Static open ( component ): void Parameters # Name Type component ReactElement > Returns # void","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#class-commandoverlay","text":"Renderer . Component .CommandOverlay","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#accessors","text":"component isOpen","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#constructor","text":"\u2022 new CommandOverlay ()","title":"constructor"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#component","text":"\u2022 Static get component (): ReactElement >","title":"component"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#isopen","text":"\u2022 Static get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#close","text":"\u25b8 Static close (): void","title":"close"},{"location":"extensions/api/classes/renderer.component.commandoverlay/#open","text":"\u25b8 Static open ( component ): void","title":"open"},{"location":"extensions/api/classes/renderer.component.confirmdialog/","text":"Class: ConfirmDialog # Renderer . Component .ConfirmDialog Hierarchy # Component < ConfirmDialogProps > \u21b3 ConfirmDialog Table of contents # Constructors # constructor Properties # context isSaving props refs state contextType defaultParams Accessors # params Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open Constructors # constructor # \u2022 new ConfirmDialog ( props ) Parameters # Name Type props ConfirmDialogProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context isSaving # \u2022 isSaving : boolean = false props # \u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultParams # \u25aa Static defaultParams : Partial < ConfirmDialogParams > Accessors # params # \u2022 get params (): ConfirmDialogParams Returns # ConfirmDialogParams Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate close # \u25b8 close (): Promise Returns # Promise componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate ok # \u25b8 ok (): Promise Returns # Promise onClose # \u25b8 onClose (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState ( state , callback? ): void Type parameters # Name Type K K : never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ConfirmDialogProps >) => {} | Pick < Object , K> | Pick < Object , K> callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate confirm # \u25b8 Static confirm ( params ): Promise Parameters # Name Type params ConfirmDialogBooleanParams Returns # Promise open # \u25b8 Static open ( params ): void Parameters # Name Type params ConfirmDialogParams Returns # void","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#class-confirmdialog","text":"Renderer . Component .ConfirmDialog","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#hierarchy","text":"Component < ConfirmDialogProps > \u21b3 ConfirmDialog","title":"Hierarchy"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#properties","text":"context isSaving props refs state contextType defaultParams","title":"Properties"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#accessors","text":"params","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open","title":"Methods"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#constructor","text":"\u2022 new ConfirmDialog ( props )","title":"constructor"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#issaving","text":"\u2022 isSaving : boolean = false","title":"isSaving"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#props","text":"\u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#contexttype","text":"\u25aa Static Optional contextType : Context If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#defaultparams","text":"\u25aa Static defaultParams : Partial < ConfirmDialogParams >","title":"defaultParams"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#params","text":"\u2022 get params (): ConfirmDialogParams","title":"params"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#close","text":"\u25b8 close (): Promise ","title":"close"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#ok","text":"\u25b8 ok (): Promise ","title":"ok"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#onclose","text":"\u25b8 onClose (): void","title":"onClose"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#setstate","text":"\u25b8 setState ( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#confirm","text":"\u25b8 Static confirm ( params ): Promise ","title":"confirm"},{"location":"extensions/api/classes/renderer.component.confirmdialog/#open","text":"\u25b8 Static open ( params ): void","title":"open"},{"location":"extensions/api/classes/renderer.component.dialog/","text":"Class: Dialog # Renderer . Component .Dialog Hierarchy # PureComponent < DialogProps , DialogState> \u21b3 Dialog Table of contents # Constructors # constructor Properties # closeOnNavigate context props refs state contextType defaultProps Accessors # elem isOpen Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClickOutside onClose onEscapeKey onOpen open render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new Dialog ( props ) Parameters # Name Type props DialogProps | Readonly < DialogProps > Inherited from # React.PureComponent.constructor \u2022 new Dialog ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DialogProps context any Inherited from # React.PureComponent.constructor Properties # closeOnNavigate # \u2022 closeOnNavigate : IReactionDisposer context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < DialogProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : DialogState Overrides # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context