diff --git a/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html index 62050a8008..a045a05c5a 100644 --- a/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html +++ b/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -1024,13 +1024,13 @@

Properties#

templateContext#

templateContext: any

-

Defined in src/extensions/cluster-feature.ts:29

+

Defined in src/extensions/cluster-feature.ts:29

this field sets the template parameters that are to be applied to any templated kubernetes resources that are to be installed for the feature. See the renderTemplates() method for more details

Methods#

Protected applyResources#

applyResources(cluster: Cluster, resourceSpec: string | string[]): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:85

+

Defined in src/extensions/cluster-feature.ts:85

this is a helper method that conveniently applies kubernetes resources to the cluster.

Parameters:

@@ -1058,7 +1058,7 @@ See the renderTemplates() method for more details


Abstract install#

install(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:47

+

Defined in src/extensions/cluster-feature.ts:47

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be installed. The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi)

Parameters:

@@ -1082,7 +1082,7 @@ of this method should install kubernetes resources using the applyResources() me

Protected renderTemplates#

renderTemplates(folderPath: string): string[]

-

Defined in src/extensions/cluster-feature.ts:109

+

Defined in src/extensions/cluster-feature.ts:109

this is a helper method that conveniently reads kubernetes resource files into a string array. It also fills templated resource files with the template parameter values specified by the templateContext field. Templated files must end with the extension '.hb' and the template syntax must be compatible with handlebars.js

Parameters:

@@ -1107,7 +1107,7 @@ specified by the templateContext field. Templated files must end with the extens

Abstract uninstall#

uninstall(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:63

+

Defined in src/extensions/cluster-feature.ts:63

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be uninstalled. The implementation of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)

Parameters:

@@ -1131,7 +1131,7 @@ of this method should uninstall kubernetes resources using the kubernetes api (K

Abstract updateStatus#

updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus

-

Defined in src/extensions/cluster-feature.ts:75

+

Defined in src/extensions/cluster-feature.ts:75

to be implemented in the derived class, this method is called periodically by Lens to determine details about the feature's current status. The implementation of this method should provide the current status information. The currentVersion and latestVersion fields may be displayed by Lens in describing the feature. The installed field should be set to true if the feature has been installed, otherwise false. Also, Lens relies on the canUpgrade field to determine if the feature @@ -1158,7 +1158,7 @@ can be upgraded so the implementation should set the canUpgrade field according


Abstract upgrade#

upgrade(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:55

+

Defined in src/extensions/cluster-feature.ts:55

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be upgraded. The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature

Parameters:

@@ -1182,20 +1182,20 @@ of this method should upgrade the kubernetes resources already installed, if rel

Object literals#

status#

status: object#

-

Defined in src/extensions/cluster-feature.ts:34

+

Defined in src/extensions/cluster-feature.ts:34

this field holds the current feature status, is accessed directly by Lens

canUpgrade#

canUpgrade: false = false

-

Defined in src/extensions/cluster-feature.ts:38

+

Defined in src/extensions/cluster-feature.ts:38

currentVersion#

currentVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:35

+

Defined in src/extensions/cluster-feature.ts:35

installed#

installed: false = false

-

Defined in src/extensions/cluster-feature.ts:36

+

Defined in src/extensions/cluster-feature.ts:36

latestVersion#

latestVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:37

+

Defined in src/extensions/cluster-feature.ts:37

diff --git a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html index 0db7e6d721..5cf50e1ee8 100644 --- a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -1482,7 +1482,7 @@

Constructors#

constructor#

+ new Cluster(model: ClusterModel): Cluster

-

Defined in src/main/cluster.ts:256

+

Defined in src/main/cluster.ts:256

Parameters:

@@ -1502,206 +1502,206 @@

Properties#

accessible#

accessible: boolean = false

-

Defined in src/main/cluster.ts:149

+

Defined in src/main/cluster.ts:149

Can user access cluster resources

observable


accessibleNamespaces#

accessibleNamespaces: string[] = []

Implementation of ClusterModel.accessibleNamespaces

-

Defined in src/main/cluster.ts:217

+

Defined in src/main/cluster.ts:217

List of accessible namespaces provided by user in the Cluster Settings

observable


Protected activated#

activated: boolean = false

-

Defined in src/main/cluster.ts:82

+

Defined in src/main/cluster.ts:82


allowedNamespaces#

allowedNamespaces: string[] = []

-

Defined in src/main/cluster.ts:204

+

Defined in src/main/cluster.ts:204

List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

observable


allowedResources#

allowedResources: string[] = []

-

Defined in src/main/cluster.ts:211

+

Defined in src/main/cluster.ts:211

List of allowed resources

observable

internal


apiUrl#

apiUrl: string

-

Defined in src/main/cluster.ts:124

+

Defined in src/main/cluster.ts:124

Kubernetes API server URL

observable


contextHandler#

contextHandler: ContextHandler

-

Defined in src/main/cluster.ts:73

+

Defined in src/main/cluster.ts:73

Context handler

internal


contextName#

contextName: string

Implementation of ClusterModel.contextName

-

Defined in src/main/cluster.ts:106

+

Defined in src/main/cluster.ts:106

Kubeconfig context name

observable


disconnected#

disconnected: boolean = true

-

Defined in src/main/cluster.ts:167

+

Defined in src/main/cluster.ts:167

Is cluster disconnected. False if user has selected to connect.

observable


enabled#

enabled: boolean = false

-

Defined in src/main/cluster.ts:137

+

Defined in src/main/cluster.ts:137

Is cluster instance enabled (disabled clusters are currently hidden)

observable


Protected eventDisposers#

eventDisposers: Function[] = []

-

Defined in src/main/cluster.ts:81

+

Defined in src/main/cluster.ts:81


failureReason#

failureReason: string

-

Defined in src/main/cluster.ts:173

+

Defined in src/main/cluster.ts:173

Connection failure reason

observable


id#

id: ClusterId

Implementation of ClusterModel.id

-

Defined in src/main/cluster.ts:61

+

Defined in src/main/cluster.ts:61

Unique id for a cluster


initialized#

initialized: boolean = false

-

Defined in src/main/cluster.ts:100

+

Defined in src/main/cluster.ts:100

Is cluster object initialized

observable


initializing#

initializing: boolean = false

-

Defined in src/main/cluster.ts:93

+

Defined in src/main/cluster.ts:93

Is cluster object initializinng on-going

observable


isAdmin#

isAdmin: boolean = false

-

Defined in src/main/cluster.ts:179

+

Defined in src/main/cluster.ts:179

Does user have admin like access

observable


isGlobalWatchEnabled#

isGlobalWatchEnabled: boolean = false

-

Defined in src/main/cluster.ts:186

+

Defined in src/main/cluster.ts:186

Global watch-api accessibility , e.g. "/api/v1/services?watch=1"

observable


kubeConfigPath#

kubeConfigPath: string

Implementation of ClusterModel.kubeConfigPath

-

Defined in src/main/cluster.ts:118

+

Defined in src/main/cluster.ts:118

Path to kubeconfig

observable


kubeCtl#

kubeCtl: Kubectl

-

Defined in src/main/cluster.ts:67

+

Defined in src/main/cluster.ts:67

Kubectl

internal


kubeProxyUrl#

kubeProxyUrl: string

-

Defined in src/main/cluster.ts:131

+

Defined in src/main/cluster.ts:131

Internal authentication proxy URL

observable

internal


Protected kubeconfigManager#

kubeconfigManager: KubeconfigManager

-

Defined in src/main/cluster.ts:80

+

Defined in src/main/cluster.ts:80


metadata#

metadata: ClusterMetadata

Implementation of ClusterModel.metadata

-

Defined in src/main/cluster.ts:198

+

Defined in src/main/cluster.ts:198

Metadata

observable


online#

online: boolean = false

-

Defined in src/main/cluster.ts:143

+

Defined in src/main/cluster.ts:143

Is cluster online

observable


ownerRef#

ownerRef: string

Implementation of ClusterModel.ownerRef

-

Defined in src/main/cluster.ts:79

+

Defined in src/main/cluster.ts:79

Owner reference

If extension sets this it needs to also mark cluster as enabled on activate (or when added to a store)


preferences#

preferences: ClusterPreferences

Implementation of ClusterModel.preferences

-

Defined in src/main/cluster.ts:192

+

Defined in src/main/cluster.ts:192

Preferences

observable


ready#

ready: boolean = false

-

Defined in src/main/cluster.ts:155

+

Defined in src/main/cluster.ts:155

Is cluster instance in usable state

observable


reconnecting#

reconnecting: boolean = false

-

Defined in src/main/cluster.ts:161

+

Defined in src/main/cluster.ts:161

Is cluster currently reconnecting

observable


whenInitialized#

whenInitialized: Promise‹void› & object = when(() => this.initialized)

-

Defined in src/main/cluster.ts:85

+

Defined in src/main/cluster.ts:85


whenReady#

whenReady: Promise‹void› & object = when(() => this.ready)

-

Defined in src/main/cluster.ts:86

+

Defined in src/main/cluster.ts:86


workspace#

workspace: WorkspaceId

Implementation of ClusterModel.workspace

-

Defined in src/main/cluster.ts:112

+

Defined in src/main/cluster.ts:112

Workspace id

observable

Accessors#

available#

get available(): boolean

-

Defined in src/main/cluster.ts:224

+

Defined in src/main/cluster.ts:224

Is cluster available

computed

Returns: boolean


isManaged#

get isManaged(): boolean

-

Defined in src/main/cluster.ts:276

+

Defined in src/main/cluster.ts:276

Is cluster managed by an extension

Returns: boolean


name#

get name(): string

-

Defined in src/main/cluster.ts:233

+

Defined in src/main/cluster.ts:233

Cluster name

computed

Returns: string


prometheusPreferences#

get prometheusPreferences(): ClusterPrometheusPreferences

-

Defined in src/main/cluster.ts:243

+

Defined in src/main/cluster.ts:243

Prometheus preferences

computed

internal

@@ -1709,13 +1709,13 @@

version#

get version(): string

-

Defined in src/main/cluster.ts:254

+

Defined in src/main/cluster.ts:254

Kubernetes version

Returns: string

Methods#

activate#

activate(force: boolean): Promise‹void›

-

Defined in src/main/cluster.ts:352

+

Defined in src/main/cluster.ts:352

internal

Parameters:

@@ -1740,13 +1740,13 @@

Protected bindEvents#

bindEvents(): void

-

Defined in src/main/cluster.ts:321

+

Defined in src/main/cluster.ts:321

internal

Returns: void


canI#

canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:569

+

Defined in src/main/cluster.ts:569

internal

Parameters:

@@ -1769,7 +1769,7 @@

canUseWatchApi#

canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:601

+

Defined in src/main/cluster.ts:601

internal

Parameters:

@@ -1792,39 +1792,39 @@

disconnect#

disconnect(): void

-

Defined in src/main/cluster.ts:400

+

Defined in src/main/cluster.ts:400

internal

Returns: void


Protected ensureKubectl#

ensureKubectl(): Promise‹boolean›

-

Defined in src/main/cluster.ts:380

+

Defined in src/main/cluster.ts:380

internal

Returns: Promise‹boolean›


Protected getAllowedNamespaces#

getAllowedNamespaces(): Promise‹string[]›

-

Defined in src/main/cluster.ts:680

+

Defined in src/main/cluster.ts:680

Returns: Promise‹string[]›


Protected getAllowedResources#

getAllowedResources(): Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

-

Defined in src/main/cluster.ts:704

+

Defined in src/main/cluster.ts:704

Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›


Protected getConnectionStatus#

getConnectionStatus(): Promise‹ClusterStatus›

-

Defined in src/main/cluster.ts:525

+

Defined in src/main/cluster.ts:525

Returns: Promise‹ClusterStatus›


Protected getKubeconfig#

getKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:478

+

Defined in src/main/cluster.ts:478

Returns: KubeConfig


getMeta#

getMeta(): object

-

Defined in src/main/cluster.ts:668

+

Defined in src/main/cluster.ts:668

Returns: object

@@ -1880,25 +1880,25 @@

getProxyKubeconfig#

getProxyKubeconfig(): Promise‹KubeConfig›

-

Defined in src/main/cluster.ts:485

+

Defined in src/main/cluster.ts:485

internal

Returns: Promise‹KubeConfig›


getProxyKubeconfigPath#

getProxyKubeconfigPath(): Promise‹string›

-

Defined in src/main/cluster.ts:494

+

Defined in src/main/cluster.ts:494

internal

Returns: Promise‹string›


getState#

getState(): ClusterState

-

Defined in src/main/cluster.ts:629

+

Defined in src/main/cluster.ts:629

Serializable cluster-state used for sync btw main <-> renderer

Returns: ClusterState


init#

init(port: number): Promise‹void›

-

Defined in src/main/cluster.ts:296

+

Defined in src/main/cluster.ts:296

Initialize a cluster (can be done only in main process)

internal

Parameters:

@@ -1922,7 +1922,7 @@

isAllowedResource#

isAllowedResource(kind: string): boolean

-

Defined in src/main/cluster.ts:739

+

Defined in src/main/cluster.ts:739

Parameters:

@@ -1942,13 +1942,13 @@

isClusterAdmin#

isClusterAdmin(): Promise‹boolean›

-

Defined in src/main/cluster.ts:590

+

Defined in src/main/cluster.ts:590

internal

Returns: Promise‹boolean›


Protected k8sRequest#

k8sRequestT›(path: string, options: RequestPromiseOptions): Promise‹T›

-

Defined in src/main/cluster.ts:498

+

Defined in src/main/cluster.ts:498

Type parameters:

T

Parameters:

@@ -1977,7 +1977,7 @@

pushState#

pushState(state: ClusterState): void

-

Defined in src/main/cluster.ts:662

+

Defined in src/main/cluster.ts:662

internal

Parameters:

@@ -2002,13 +2002,13 @@

reconnect#

reconnect(): Promise‹void›

-

Defined in src/main/cluster.ts:390

+

Defined in src/main/cluster.ts:390

internal

Returns: Promise‹void›


refresh#

refresh(opts: ClusterRefreshOptions): Promise‹void›

-

Defined in src/main/cluster.ts:419

+

Defined in src/main/cluster.ts:419

internal

Parameters:

@@ -2033,25 +2033,25 @@

refreshAllowedResources#

refreshAllowedResources(): Promise‹void›

-

Defined in src/main/cluster.ts:473

+

Defined in src/main/cluster.ts:473

internal

Returns: Promise‹void›


refreshConnectionStatus#

refreshConnectionStatus(): Promise‹void›

-

Defined in src/main/cluster.ts:462

+

Defined in src/main/cluster.ts:462

internal

Returns: Promise‹void›


refreshMetadata#

refreshMetadata(): Promise‹void›

-

Defined in src/main/cluster.ts:438

+

Defined in src/main/cluster.ts:438

internal

Returns: Promise‹void›


setState#

setState(state: ClusterState): void

-

Defined in src/main/cluster.ts:654

+

Defined in src/main/cluster.ts:654

internal

Parameters:

@@ -2074,18 +2074,18 @@

toJSON#

toJSON(): ClusterModel

-

Defined in src/main/cluster.ts:609

+

Defined in src/main/cluster.ts:609

Returns: ClusterModel


Protected unbindEvents#

unbindEvents(): void

-

Defined in src/main/cluster.ts:341

+

Defined in src/main/cluster.ts:341

internal

Returns: void


updateModel#

updateModel(model: ClusterModel): void

-

Defined in src/main/cluster.ts:285

+

Defined in src/main/cluster.ts:285

Update cluster data model

Parameters:

diff --git a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html index f9cdeac5cc..43b06fd408 100644 --- a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -1024,18 +1024,18 @@

Accessors#

activeCluster#

-

get activeCluster(): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:41

+

get activeCluster(): Cluster | null

+

Defined in src/extensions/stores/cluster-store.ts:41

Get active cluster (a cluster which is currently visible)

-

Returns: Cluster

+

Returns: Cluster | null


activeClusterId#

get activeClusterId(): string

-

Defined in src/extensions/stores/cluster-store.ts:20

+

Defined in src/extensions/stores/cluster-store.ts:20

Active cluster id

Returns: string

set activeClusterId(id: ClusterId): void

-

Defined in src/extensions/stores/cluster-store.ts:27

+

Defined in src/extensions/stores/cluster-store.ts:27

Set active cluster id

Parameters:

@@ -1056,31 +1056,31 @@

clusters#

get clusters(): ObservableMap‹string, Cluster

-

Defined in src/extensions/stores/cluster-store.ts:34

+

Defined in src/extensions/stores/cluster-store.ts:34

Map of all clusters

Returns: ObservableMap‹string, Cluster


clustersList#

get clustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:52

+

Defined in src/extensions/stores/cluster-store.ts:48

Array of all clusters

Returns: Cluster[]


connectedClustersList#

get connectedClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:66

+

Defined in src/extensions/stores/cluster-store.ts:62

Array of all clusters that have active connection to a Kubernetes cluster

Returns: Cluster[]


enabledClustersList#

get enabledClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:59

+

Defined in src/extensions/stores/cluster-store.ts:55

Array of all enabled clusters

Returns: Cluster[]

Methods#

addCluster#

addCluster(model: ClusterModel | Cluster): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:98

+

Defined in src/extensions/stores/cluster-store.ts:94

Add a cluster to store

Parameters:

@@ -1103,7 +1103,7 @@

addClusters#

addClusters(...models: ClusterModel[]): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:90

+

Defined in src/extensions/stores/cluster-store.ts:86

Add clusters to store

Parameters:

@@ -1126,7 +1126,7 @@

getById#

getById(id: ClusterId): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:74

+

Defined in src/extensions/stores/cluster-store.ts:70

Get cluster object by cluster id

Parameters:

@@ -1149,7 +1149,7 @@

getByWorkspaceId#

getByWorkspaceId(workspaceId: string): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:82

+

Defined in src/extensions/stores/cluster-store.ts:78

Get all clusters belonging to a workspace

Parameters:

@@ -1172,7 +1172,7 @@

removeById#

removeById(clusterId: ClusterId): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:114

+

Defined in src/extensions/stores/cluster-store.ts:110

Remove a cluster from store by id

Parameters:

@@ -1195,7 +1195,7 @@

removeByWorkspaceId#

removeByWorkspaceId(workspaceId: string): void

-

Defined in src/extensions/stores/cluster-store.ts:122

+

Defined in src/extensions/stores/cluster-store.ts:118

Remove all clusters belonging to a workspaces

Parameters:

@@ -1218,7 +1218,7 @@

removeCluster#

removeCluster(model: ClusterModel): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:106

+

Defined in src/extensions/stores/cluster-store.ts:102

Remove a cluster from store

Parameters:

@@ -1242,7 +1242,7 @@

Static getInstance#

getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:15

+

Defined in src/common/utils/singleton.ts:15

Type parameters:

T

Parameters:

@@ -1265,7 +1265,7 @@

Static resetInstance#

resetInstance(): void

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:23

+

Defined in src/common/utils/singleton.ts:23

Returns: void

diff --git a/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html index 6082c6d794..50eefba6bb 100644 --- a/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -918,8 +918,8 @@
  • - - Protected storeConfig + + Protected Optional storeConfig
  • @@ -1141,7 +1141,7 @@
  • extension
  • isLoaded
  • params
  • -
  • storeConfig
  • +
  • storeConfig
  • syncDisposers
  • whenLoaded
  • @@ -1175,7 +1175,7 @@

    Protected constructor#

    + new ExtensionStore(params: BaseStoreParams): ExtensionStore

    Inherited from ExtensionStore.constructor

    -

    Defined in src/common/base-store.ts:26

    +

    Defined in src/common/base-store.ts:26

    Parameters:

    @@ -1195,61 +1195,61 @@

    Properties#

    Protected extension#

    extension: LensExtension

    -

    Defined in src/extensions/extension-store.ts:6

    +

    Defined in src/extensions/extension-store.ts:6


    isLoaded#

    isLoaded: boolean = false

    Inherited from ExtensionStore.isLoaded

    -

    Defined in src/common/base-store.ts:26

    +

    Defined in src/common/base-store.ts:26


    Protected params#

    params: BaseStoreParams

    Inherited from ExtensionStore.params

    -

    Defined in src/common/base-store.ts:28

    +

    Defined in src/common/base-store.ts:28


    -

    Protected storeConfig#

    -

    storeConfig: Config‹T›

    -

    Inherited from ExtensionStore.storeConfig

    -

    Defined in src/common/base-store.ts:22

    +

    Protected Optional storeConfig#

    +

    storeConfig? : Config‹T›

    +

    Inherited from ExtensionStore.storeConfig

    +

    Defined in src/common/base-store.ts:22


    Protected syncDisposers#

    syncDisposers: Function[] = []

    Inherited from ExtensionStore.syncDisposers

    -

    Defined in src/common/base-store.ts:23

    +

    Defined in src/common/base-store.ts:23


    whenLoaded#

    whenLoaded: Promise‹void› & object = when(() => this.isLoaded)

    Inherited from ExtensionStore.whenLoaded

    -

    Defined in src/common/base-store.ts:25

    +

    Defined in src/common/base-store.ts:25

    Accessors#

    name#

    get name(): string

    Inherited from ExtensionStore.name

    -

    Defined in src/common/base-store.ts:38

    +

    Defined in src/common/base-store.ts:38

    Returns: string


    path#

    get path(): string

    Inherited from ExtensionStore.path

    -

    Defined in src/common/base-store.ts:50

    +

    Defined in src/common/base-store.ts:50

    Returns: string


    Protected syncMainChannel#

    get syncMainChannel(): string

    Inherited from ExtensionStore.syncMainChannel

    -

    Defined in src/common/base-store.ts:46

    +

    Defined in src/common/base-store.ts:46

    Returns: string


    Protected syncRendererChannel#

    get syncRendererChannel(): string

    Inherited from ExtensionStore.syncRendererChannel

    -

    Defined in src/common/base-store.ts:42

    +

    Defined in src/common/base-store.ts:42

    Returns: string

    Methods#

    Protected applyWithoutSync#

    applyWithoutSync(callback: function): void

    Inherited from ExtensionStore.applyWithoutSync

    -

    Defined in src/common/base-store.ts:133

    +

    Defined in src/common/base-store.ts:136

    Parameters:

    callback: function

    ▸ (): void

    @@ -1258,25 +1258,25 @@

    Protected cwd#

    cwd(): string

    Overrides void

    -

    Defined in src/extensions/extension-store.ts:20

    +

    Defined in src/extensions/extension-store.ts:20

    Returns: string


    disableSync#

    disableSync(): void

    Inherited from ExtensionStore.disableSync

    -

    Defined in src/common/base-store.ts:128

    +

    Defined in src/common/base-store.ts:131

    Returns: void


    enableSync#

    enableSync(): void

    Inherited from ExtensionStore.enableSync

    -

    Defined in src/common/base-store.ts:91

    +

    Defined in src/common/base-store.ts:94

    Returns: void


    Protected Abstract fromStore#

    fromStore(data: T): void

    Inherited from ExtensionStore.fromStore

    -

    Defined in src/common/base-store.ts:163

    +

    Defined in src/common/base-store.ts:166

    fromStore is called internally when a child class syncs with the file system.

    Parameters:

    @@ -1301,18 +1301,18 @@ system.

    Protected init#

    init(): Promise‹void›

    Inherited from ExtensionStore.init

    -

    Defined in src/common/base-store.ts:54

    +

    Defined in src/common/base-store.ts:54

    Returns: Promise‹void›


    load#

    load(): Promise‹void›

    Overrides void

    -

    Defined in src/extensions/extension-store.ts:14

    +

    Defined in src/extensions/extension-store.ts:14

    Returns: Promise‹void›


    loadExtension#

    loadExtension(extension: LensExtension): Promise‹void›

    -

    Defined in src/extensions/extension-store.ts:8

    +

    Defined in src/extensions/extension-store.ts:8

    Parameters:

    @@ -1333,7 +1333,7 @@ system.

    Protected onModelChange#

    onModelChange(model: T): Promise‹void›

    Inherited from ExtensionStore.onModelChange

    -

    Defined in src/common/base-store.ts:149

    +

    Defined in src/common/base-store.ts:152

    Parameters:

    @@ -1354,7 +1354,7 @@ system.

    Protected onSync#

    onSync(model: T): void

    Inherited from ExtensionStore.onSync

    -

    Defined in src/common/base-store.ts:142

    +

    Defined in src/common/base-store.ts:145

    Parameters:

    @@ -1375,7 +1375,7 @@ system.

    Protected onSyncFromMain#

    onSyncFromMain(model: T): void

    Inherited from ExtensionStore.onSyncFromMain

    -

    Defined in src/common/base-store.ts:117

    +

    Defined in src/common/base-store.ts:120

    Parameters:

    @@ -1396,7 +1396,7 @@ system.

    Protected saveToFile#

    saveToFile(model: T): Promise‹void›

    Inherited from ExtensionStore.saveToFile

    -

    Defined in src/common/base-store.ts:83

    +

    Defined in src/common/base-store.ts:83

    Parameters:

    @@ -1417,7 +1417,7 @@ system.

    Abstract toJSON#

    toJSON(): T

    Inherited from ExtensionStore.toJSON

    -

    Defined in src/common/base-store.ts:172

    +

    Defined in src/common/base-store.ts:175

    toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representaion of the current state.

    It is recommended that a round trip is valid. Namely, calling @@ -1427,13 +1427,13 @@ produce a JSON serializable object representaion of the current state.

    unregisterIpcListener#

    unregisterIpcListener(): void

    Inherited from ExtensionStore.unregisterIpcListener

    -

    Defined in src/common/base-store.ts:123

    +

    Defined in src/common/base-store.ts:126

    Returns: void


    Static getInstance#

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    Inherited from ExtensionStore.getInstance

    -

    Defined in src/common/utils/singleton.ts:15

    +

    Defined in src/common/utils/singleton.ts:15

    Type parameters:

    T

    Parameters:

    @@ -1456,7 +1456,7 @@ produce a JSON serializable object representaion of the current state.

    Static resetInstance#

    resetInstance(): void

    Inherited from ExtensionStore.resetInstance

    -

    Defined in src/common/utils/singleton.ts:23

    +

    Defined in src/common/utils/singleton.ts:23

    Returns: void

    diff --git a/latest/extensions/api/classes/_core_api_stores_.workspace/index.html b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html index 6e2d5985dd..a4891fd303 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -1066,7 +1066,7 @@

    Constructors#

    constructor#

    + new Workspace(data: WorkspaceModel): Workspace

    -

    Defined in src/common/workspace-store.ts:72

    +

    Defined in src/common/workspace-store.ts:72

    Parameters:

    @@ -1088,53 +1088,53 @@

    [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { Object.assign(this, model); })

    -

    Defined in src/common/workspace-store.ts:135

    +

    Defined in src/common/workspace-store.ts:135


    Optional description#

    description? : string

    Implementation of WorkspaceModel.description

    -

    Defined in src/common/workspace-store.ts:54

    +

    Defined in src/common/workspace-store.ts:54

    Workspace description

    observable


    id#

    id: WorkspaceId

    Implementation of WorkspaceModel.id

    -

    Defined in src/common/workspace-store.ts:42

    +

    Defined in src/common/workspace-store.ts:42

    Unique id for workspace

    observable


    Optional lastActiveClusterId#

    lastActiveClusterId? : ClusterId

    Implementation of WorkspaceModel.lastActiveClusterId

    -

    Defined in src/common/workspace-store.ts:69

    +

    Defined in src/common/workspace-store.ts:69

    Last active cluster id

    observable


    name#

    name: string

    Implementation of WorkspaceModel.name

    -

    Defined in src/common/workspace-store.ts:48

    +

    Defined in src/common/workspace-store.ts:48

    Workspace name

    observable


    Optional ownerRef#

    ownerRef? : string

    Implementation of WorkspaceModel.ownerRef

    -

    Defined in src/common/workspace-store.ts:62

    +

    Defined in src/common/workspace-store.ts:62

    Workspace owner reference

    If extension sets ownerRef then it needs to explicitly mark workspace as enabled onActivate (or when workspace is saved)

    observable

    Accessors#

    enabled#

    get enabled(): boolean

    -

    Defined in src/common/workspace-store.ts:91

    +

    Defined in src/common/workspace-store.ts:91

    Is workspace enabled

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    observable

    Returns: boolean

    set enabled(enabled: boolean): void

    -

    Defined in src/common/workspace-store.ts:95

    +

    Defined in src/common/workspace-store.ts:95

    Is workspace enabled

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    Parameters:

    @@ -1156,19 +1156,19 @@

    isManaged#

    get isManaged(): boolean

    -

    Defined in src/common/workspace-store.ts:102

    +

    Defined in src/common/workspace-store.ts:102

    Is workspace managed by an extension

    Returns: boolean

    Methods#

    getState#

    getState(): WorkspaceState

    -

    Defined in src/common/workspace-store.ts:110

    +

    Defined in src/common/workspace-store.ts:110

    Get workspace state

    Returns: WorkspaceState


    pushState#

    pushState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:122

    +

    Defined in src/common/workspace-store.ts:122

    Push state

    internal

    Parameters:

    @@ -1194,7 +1194,7 @@

    setState#

    setState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:131

    +

    Defined in src/common/workspace-store.ts:131

    Parameters:

    @@ -1216,7 +1216,7 @@

    toJSON#

    toJSON(): WorkspaceModel

    -

    Defined in src/common/workspace-store.ts:139

    +

    Defined in src/common/workspace-store.ts:139

    Returns: WorkspaceModel

    diff --git a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html index c78c22187d..5a9d8ecdf5 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -1048,22 +1048,22 @@

    Properties#

    Static defaultId#

    defaultId: WorkspaceId = InternalWorkspaceStore.defaultId

    -

    Defined in src/extensions/stores/workspace-store.ts:17

    +

    Defined in src/extensions/stores/workspace-store.ts:17

    Default workspace id, this workspace is always present

    Accessors#

    currentWorkspace#

    get currentWorkspace(): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:43

    +

    Defined in src/extensions/stores/workspace-store.ts:43

    Currently active workspace

    Returns: Workspace


    currentWorkspaceId#

    get currentWorkspaceId(): string

    -

    Defined in src/extensions/stores/workspace-store.ts:22

    +

    Defined in src/extensions/stores/workspace-store.ts:22

    Currently active workspace id

    Returns: string

    set currentWorkspaceId(id: string): void

    -

    Defined in src/extensions/stores/workspace-store.ts:29

    +

    Defined in src/extensions/stores/workspace-store.ts:29

    Set active workspace id

    Parameters:

    @@ -1084,25 +1084,25 @@

    enabledWorkspacesList#

    get enabledWorkspacesList(): Workspace[]

    -

    Defined in src/extensions/stores/workspace-store.ts:57

    +

    Defined in src/extensions/stores/workspace-store.ts:57

    Array of all enabled (visible) workspaces

    Returns: Workspace[]


    workspaces#

    get workspaces(): ObservableMap‹string, Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:36

    +

    Defined in src/extensions/stores/workspace-store.ts:36

    Map of all workspaces

    Returns: ObservableMap‹string, Workspace


    workspacesList#

    get workspacesList(): Workspace[]

    -

    Defined in src/extensions/stores/workspace-store.ts:50

    +

    Defined in src/extensions/stores/workspace-store.ts:50

    Array of all workspaces

    Returns: Workspace[]

    Methods#

    addWorkspace#

    addWorkspace(workspace: Workspace): Workspace‹›

    -

    Defined in src/extensions/stores/workspace-store.ts:89

    +

    Defined in src/extensions/stores/workspace-store.ts:89

    Add a workspace to store

    Parameters:

    @@ -1125,7 +1125,7 @@

    getById#

    getById(id: WorkspaceId): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:65

    +

    Defined in src/extensions/stores/workspace-store.ts:65

    Get workspace by id

    Parameters:

    @@ -1148,7 +1148,7 @@

    getByName#

    getByName(name: string): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:73

    +

    Defined in src/extensions/stores/workspace-store.ts:73

    Get workspace by name

    Parameters:

    @@ -1171,7 +1171,7 @@

    removeWorkspace#

    removeWorkspace(workspace: Workspace): void

    -

    Defined in src/extensions/stores/workspace-store.ts:105

    +

    Defined in src/extensions/stores/workspace-store.ts:105

    Remove workspace from store

    Parameters:

    @@ -1194,7 +1194,7 @@

    removeWorkspaceById#

    removeWorkspaceById(id: WorkspaceId): void

    -

    Defined in src/extensions/stores/workspace-store.ts:113

    +

    Defined in src/extensions/stores/workspace-store.ts:113

    Remove workspace by id

    Parameters:

    @@ -1217,7 +1217,7 @@

    setActive#

    setActive(id: string): void

    -

    Defined in src/extensions/stores/workspace-store.ts:81

    +

    Defined in src/extensions/stores/workspace-store.ts:81

    Set active workspace

    Parameters:

    @@ -1242,7 +1242,7 @@

    updateWorkspace#

    updateWorkspace(workspace: Workspace): void

    -

    Defined in src/extensions/stores/workspace-store.ts:97

    +

    Defined in src/extensions/stores/workspace-store.ts:97

    Update a workspace in store

    Parameters:

    @@ -1266,7 +1266,7 @@

    Static getInstance#

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    Inherited from ExtensionStore.getInstance

    -

    Defined in src/common/utils/singleton.ts:15

    +

    Defined in src/common/utils/singleton.ts:15

    Type parameters:

    T

    Parameters:

    @@ -1289,7 +1289,7 @@

    Static resetInstance#

    resetInstance(): void

    Inherited from ExtensionStore.resetInstance

    -

    Defined in src/common/utils/singleton.ts:23

    +

    Defined in src/common/utils/singleton.ts:23

    Returns: void

    diff --git a/latest/extensions/api/classes/_core_api_utils_.singleton/index.html b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html index 525ad50136..6b2aaaa475 100644 --- a/latest/extensions/api/classes/_core_api_utils_.singleton/index.html +++ b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -897,7 +897,7 @@

    Methods#

    Static getInstance#

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    -

    Defined in src/common/utils/singleton.ts:15

    +

    Defined in src/common/utils/singleton.ts:15

    Type parameters:

    T

    Parameters:

    @@ -919,7 +919,7 @@

    Static resetInstance#

    resetInstance(): void

    -

    Defined in src/common/utils/singleton.ts:23

    +

    Defined in src/common/utils/singleton.ts:23

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html index f78d394d8c..d5242cea84 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/badge/badge.tsx:15

    +

    Defined in src/renderer/components/badge/badge.tsx:15

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.button/index.html b/latest/extensions/api/classes/_renderer_api_components_.button/index.html index 13b3fd4dce..84d39c87c0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.button/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.button/index.html @@ -1265,7 +1265,7 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/button/button.tsx:27

    +

    Defined in src/renderer/components/button/button.tsx:27

    Returns: Element‹›


    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html index 4a5efd67b2..3944ac2626 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -1282,12 +1282,12 @@ lifecycle events from running.


    getValue#

    getValue(): boolean

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:25

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:25

    Returns: boolean


    onChange#

    onChange(evt: ChangeEvent‹HTMLInputElement›): void

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:19

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:19

    Parameters:

    @@ -1307,7 +1307,7 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:31

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:31

    Returns: Element‹›


    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html b/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html index 9956e3cb50..ff5a55520a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html @@ -895,12 +895,12 @@

    Methods#

    Static close#

    close(): void

    -

    Defined in src/renderer/components/command-palette/command-container.tsx:25

    +

    Defined in src/renderer/components/command-palette/command-container.tsx:25

    Returns: void


    Static open#

    open(component: ReactElement): void

    -

    Defined in src/renderer/components/command-palette/command-container.tsx:21

    +

    Defined in src/renderer/components/command-palette/command-container.tsx:21

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html index 3845a365e1..89d7ed461b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -1327,7 +1327,7 @@ Should be used with type annotation or static contextType.


    isSaving#

    isSaving: boolean = false

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:29

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:29


    props#

    props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    @@ -1371,15 +1371,15 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static isOpen#

    isOpen: boolean = false

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:26

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:26


    Static params#

    params: ConfirmDialogParams

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

    Accessors#

    params#

    get params(): ConfirmDialogParams

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

    Returns: ConfirmDialogParams

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1470,7 +1470,7 @@ prevents this from being invoked.


    close#

    close(): void

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:65

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:65

    Returns: void


    Optional componentDidCatch#

    @@ -1670,18 +1670,18 @@ lifecycle events from running.


    ok#

    ok(): Promise‹void›

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:51

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:51

    Returns: Promise‹void›


    onClose#

    onClose(): void

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

    Returns: Element‹›


    setState#

    @@ -1733,12 +1733,12 @@ and componentDidUpdate will not be called.


    Static close#

    close(): void

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:36

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:36

    Returns: void


    Static open#

    open(params: ConfirmDialogParams): void

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

    Parameters:

    @@ -1758,19 +1758,19 @@ and componentDidUpdate will not be called.

    Object literals#

    defaultParams#

    defaultParams: object#

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

    icon#

    icon: Element‹› =

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

    labelCancel#

    labelCancel: string = "Cancel"

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

    labelOk#

    labelOk: string = "Ok"

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

    ok#

    ok: any = noop

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html index ef54131280..67a7338bea 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/spinner/cube-spinner.tsx:11

    +

    Defined in src/renderer/components/spinner/cube-spinner.tsx:11

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html index dc04bbd06d..415c162d01 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -1235,16 +1235,16 @@

    Properties#

    closeOnNavigate#

    closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

    -

    Defined in src/renderer/components/dialog/dialog.tsx:45

    +

    Defined in src/renderer/components/dialog/dialog.tsx:45

    Accessors#

    elem#

    get elem(): HTMLElement

    -

    Defined in src/renderer/components/dialog/dialog.tsx:51

    +

    Defined in src/renderer/components/dialog/dialog.tsx:51

    Returns: HTMLElement


    isOpen#

    get isOpen(): boolean

    -

    Defined in src/renderer/components/dialog/dialog.tsx:56

    +

    Defined in src/renderer/components/dialog/dialog.tsx:56

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1335,7 +1335,7 @@ prevents this from being invoked.


    close#

    close(): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:87

    +

    Defined in src/renderer/components/dialog/dialog.tsx:87

    Returns: void


    Optional componentDidCatch#

    @@ -1368,13 +1368,13 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/dialog/dialog.tsx:60

    +

    Defined in src/renderer/components/dialog/dialog.tsx:60

    Returns: void


    componentDidUpdate#

    componentDidUpdate(prevProps: DialogProps): void

    Overrides PageLayout.componentDidUpdate

    -

    Defined in src/renderer/components/dialog/dialog.tsx:64

    +

    Defined in src/renderer/components/dialog/dialog.tsx:64

    Parameters:

    @@ -1442,7 +1442,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/dialog/dialog.tsx:72

    +

    Defined in src/renderer/components/dialog/dialog.tsx:72

    Returns: void


    Optional componentWillUpdate#

    @@ -1513,7 +1513,7 @@ lifecycle events from running.


    onClickOutside#

    onClickOutside(evt: MouseEvent): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:121

    +

    Defined in src/renderer/components/dialog/dialog.tsx:121

    Parameters:

    @@ -1533,12 +1533,12 @@ lifecycle events from running.


    onClose#

    onClose(): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:103

    +

    Defined in src/renderer/components/dialog/dialog.tsx:103

    Returns: void


    onEscapeKey#

    onEscapeKey(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:112

    +

    Defined in src/renderer/components/dialog/dialog.tsx:112

    Parameters:

    @@ -1558,17 +1558,17 @@ lifecycle events from running.


    onOpen#

    onOpen(): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:93

    +

    Defined in src/renderer/components/dialog/dialog.tsx:93

    Returns: void


    open#

    open(): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:81

    +

    Defined in src/renderer/components/dialog/dialog.tsx:81

    Returns: void


    render#

    render(): ReactPortal‹›

    -

    Defined in src/renderer/components/dialog/dialog.tsx:130

    +

    Defined in src/renderer/components/dialog/dialog.tsx:130

    Returns: ReactPortal‹›


    Optional shouldComponentUpdate#

    @@ -1608,7 +1608,7 @@ and componentDidUpdate will not be called.


    toggle#

    toggle(isOpen: boolean): void

    -

    Defined in src/renderer/components/dialog/dialog.tsx:76

    +

    Defined in src/renderer/components/dialog/dialog.tsx:76

    Parameters:

    @@ -1628,38 +1628,38 @@ and componentDidUpdate will not be called.

    Object literals#

    state#

    state: object#

    -

    Defined in src/renderer/components/dialog/dialog.tsx:47

    +

    Defined in src/renderer/components/dialog/dialog.tsx:47

    isOpen#

    isOpen: boolean = this.props.isOpen

    -

    Defined in src/renderer/components/dialog/dialog.tsx:48

    +

    Defined in src/renderer/components/dialog/dialog.tsx:48


    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/dialog/dialog.tsx:33

    +

    Defined in src/renderer/components/dialog/dialog.tsx:33

    animated#

    animated: true = true

    -

    Defined in src/renderer/components/dialog/dialog.tsx:40

    +

    Defined in src/renderer/components/dialog/dialog.tsx:40

    close#

    close: any = noop

    -

    Defined in src/renderer/components/dialog/dialog.tsx:36

    +

    Defined in src/renderer/components/dialog/dialog.tsx:36

    isOpen#

    isOpen: false = false

    -

    Defined in src/renderer/components/dialog/dialog.tsx:34

    +

    Defined in src/renderer/components/dialog/dialog.tsx:34

    modal: true = true

    -

    Defined in src/renderer/components/dialog/dialog.tsx:39

    +

    Defined in src/renderer/components/dialog/dialog.tsx:39

    onClose#

    onClose: any = noop

    -

    Defined in src/renderer/components/dialog/dialog.tsx:38

    +

    Defined in src/renderer/components/dialog/dialog.tsx:38

    onOpen#

    onOpen: any = noop

    -

    Defined in src/renderer/components/dialog/dialog.tsx:37

    +

    Defined in src/renderer/components/dialog/dialog.tsx:37

    open#

    open: any = noop

    -

    Defined in src/renderer/components/dialog/dialog.tsx:35

    +

    Defined in src/renderer/components/dialog/dialog.tsx:35

    pinned#

    pinned: false = false

    -

    Defined in src/renderer/components/dialog/dialog.tsx:41

    +

    Defined in src/renderer/components/dialog/dialog.tsx:41

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html index ef684d8369..85305fb5b1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -1262,7 +1262,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/drawer/drawer.tsx:31

    +

    Defined in src/renderer/components/drawer/drawer.tsx:31

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1352,7 +1352,7 @@ prevents this from being invoked.


    close#

    close(): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:101

    +

    Defined in src/renderer/components/drawer/drawer.tsx:101

    Returns: void


    Optional componentDidCatch#

    @@ -1385,7 +1385,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/drawer/drawer.tsx:42

    +

    Defined in src/renderer/components/drawer/drawer.tsx:42

    Returns: void


    Optional componentDidUpdate#

    @@ -1469,7 +1469,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/drawer/drawer.tsx:49

    +

    Defined in src/renderer/components/drawer/drawer.tsx:49

    Returns: void


    Optional componentWillUpdate#

    @@ -1549,7 +1549,7 @@ lifecycle events from running.


    onClickOutside#

    onClickOutside(evt: MouseEvent): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:80

    +

    Defined in src/renderer/components/drawer/drawer.tsx:80

    Parameters:

    @@ -1569,7 +1569,7 @@ lifecycle events from running.


    onEscapeKey#

    onEscapeKey(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:70

    +

    Defined in src/renderer/components/drawer/drawer.tsx:70

    Parameters:

    @@ -1589,7 +1589,7 @@ lifecycle events from running.


    onMouseDown#

    onMouseDown(evt: MouseEvent): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:95

    +

    Defined in src/renderer/components/drawer/drawer.tsx:95

    Parameters:

    @@ -1610,17 +1610,17 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:107

    +

    Defined in src/renderer/components/drawer/drawer.tsx:107

    Returns: Element‹›


    restoreScrollPos#

    restoreScrollPos(): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:63

    +

    Defined in src/renderer/components/drawer/drawer.tsx:63

    Returns: void


    saveScrollPos#

    saveScrollPos(): void

    -

    Defined in src/renderer/components/drawer/drawer.tsx:56

    +

    Defined in src/renderer/components/drawer/drawer.tsx:56

    Returns: void


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html index 9b7d014f9a..f9b393636a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:15

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:15

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html index d91f6ea92f..a307580296 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -1189,7 +1189,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    state#

    state: State

    Overrides PageLayout.state

    -

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:14

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:14


    Static Optional contextType#

    contextType? : Context‹any›

    @@ -1494,7 +1494,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:20

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:20

    Returns: Element‹›


    setState#

    @@ -1546,7 +1546,7 @@ and componentDidUpdate will not be called.


    toggle#

    toggle(): void

    -

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:16

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:16

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html index 1e04b41e09..2d1e7986c8 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/drawer/drawer-title.tsx:11

    +

    Defined in src/renderer/components/drawer/drawer-title.tsx:11

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html index 18654a4670..546d414174 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -1086,7 +1086,7 @@

    Accessors#

    isInteractive#

    get isInteractive(): boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:33

    +

    Defined in src/renderer/components/icon/icon.tsx:33

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1363,7 +1363,7 @@ lifecycle events from running.


    onClick#

    onClick(evt: MouseEvent): void

    -

    Defined in src/renderer/components/icon/icon.tsx:40

    +

    Defined in src/renderer/components/icon/icon.tsx:40

    Parameters:

    @@ -1383,7 +1383,7 @@ lifecycle events from running.


    onKeyDown#

    onKeyDown(evt: KeyboardEvent‹any›): void

    -

    Defined in src/renderer/components/icon/icon.tsx:51

    +

    Defined in src/renderer/components/icon/icon.tsx:51

    Parameters:

    @@ -1403,7 +1403,7 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/icon/icon.tsx:70

    +

    Defined in src/renderer/components/icon/icon.tsx:70

    Returns: Element‹›


    Optional shouldComponentUpdate#

    @@ -1443,10 +1443,10 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/icon/icon.tsx:29

    +

    Defined in src/renderer/components/icon/icon.tsx:29

    focusable#

    focusable: true = true

    -

    Defined in src/renderer/components/icon/icon.tsx:30

    +

    Defined in src/renderer/components/icon/icon.tsx:30

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.input/index.html b/latest/extensions/api/classes/_renderer_api_components_.input/index.html index 2addb9551b..1d1de53a1d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.input/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.input/index.html @@ -1390,7 +1390,7 @@ Should be used with type annotation or static contextType.


    input#

    input: InputElement

    -

    Defined in src/renderer/components/input/input.tsx:58

    +

    Defined in src/renderer/components/input/input.tsx:58


    props#

    props: Readonly‹InputProps› & Readonly‹object›

    @@ -1410,7 +1410,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    validators#

    validators: InputValidator[] = []

    -

    Defined in src/renderer/components/input/input.tsx:59

    +

    Defined in src/renderer/components/input/input.tsx:59


    Static Optional contextType#

    contextType? : Context‹any›

    @@ -1433,16 +1433,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/input/input.tsx:56

    +

    Defined in src/renderer/components/input/input.tsx:56

    Accessors#

    isUncontrolled#

    get isUncontrolled(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:258

    +

    Defined in src/renderer/components/input/input.tsx:258

    Returns: boolean


    showMaxLenIndicator#

    get showMaxLenIndicator(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:252

    +

    Defined in src/renderer/components/input/input.tsx:252

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1533,7 +1533,7 @@ prevents this from being invoked.


    bindRef#

    bindRef(elem: InputElement): void

    -

    Defined in src/renderer/components/input/input.tsx:285

    +

    Defined in src/renderer/components/input/input.tsx:285

    Parameters:

    @@ -1553,7 +1553,7 @@ prevents this from being invoked.


    blur#

    blur(): void

    -

    Defined in src/renderer/components/input/input.tsx:95

    +

    Defined in src/renderer/components/input/input.tsx:95

    Returns: void


    Optional componentDidCatch#

    @@ -1586,13 +1586,13 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/input/input.tsx:262

    +

    Defined in src/renderer/components/input/input.tsx:262

    Returns: void


    componentDidUpdate#

    componentDidUpdate(prevProps: InputProps): void

    Overrides PageLayout.componentDidUpdate

    -

    Defined in src/renderer/components/input/input.tsx:267

    +

    Defined in src/renderer/components/input/input.tsx:267

    Parameters:

    @@ -1703,7 +1703,7 @@ prevents this from being invoked.


    focus#

    focus(): void

    -

    Defined in src/renderer/components/input/input.tsx:91

    +

    Defined in src/renderer/components/input/input.tsx:91

    Returns: void


    forceUpdate#

    @@ -1747,17 +1747,17 @@ lifecycle events from running.


    getValue#

    getValue(): string

    -

    Defined in src/renderer/components/input/input.tsx:82

    +

    Defined in src/renderer/components/input/input.tsx:82

    Returns: string


    isValid#

    isValid(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:67

    +

    Defined in src/renderer/components/input/input.tsx:67

    Returns: boolean


    onBlur#

    onBlur(evt: FocusEvent‹InputElement›): void

    -

    Defined in src/renderer/components/input/input.tsx:208

    +

    Defined in src/renderer/components/input/input.tsx:208

    Parameters:

    @@ -1777,7 +1777,7 @@ lifecycle events from running.


    onChange#

    onChange(evt: ChangeEvent‹any›): void

    -

    Defined in src/renderer/components/input/input.tsx:217

    +

    Defined in src/renderer/components/input/input.tsx:217

    Parameters:

    @@ -1797,7 +1797,7 @@ lifecycle events from running.


    onFocus#

    onFocus(evt: FocusEvent‹InputElement›): void

    -

    Defined in src/renderer/components/input/input.tsx:199

    +

    Defined in src/renderer/components/input/input.tsx:199

    Parameters:

    @@ -1817,7 +1817,7 @@ lifecycle events from running.


    onKeyDown#

    onKeyDown(evt: KeyboardEvent‹any›): void

    -

    Defined in src/renderer/components/input/input.tsx:236

    +

    Defined in src/renderer/components/input/input.tsx:236

    Parameters:

    @@ -1838,17 +1838,17 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/input/input.tsx:289

    +

    Defined in src/renderer/components/input/input.tsx:289

    Returns: Element‹›


    select#

    select(): void

    -

    Defined in src/renderer/components/input/input.tsx:99

    +

    Defined in src/renderer/components/input/input.tsx:99

    Returns: void


    setDirty#

    setDirty(dirty: boolean): void

    -

    Defined in src/renderer/components/input/input.tsx:193

    +

    Defined in src/renderer/components/input/input.tsx:193

    Parameters:

    @@ -1882,7 +1882,7 @@ lifecycle events from running.


    setValidation#

    setValidation(errors: React.ReactNode[]): void

    -

    Defined in src/renderer/components/input/input.tsx:163

    +

    Defined in src/renderer/components/input/input.tsx:163

    Parameters:

    @@ -1902,7 +1902,7 @@ lifecycle events from running.


    setValue#

    setValue(value: string): void

    -

    Defined in src/renderer/components/input/input.tsx:71

    +

    Defined in src/renderer/components/input/input.tsx:71

    Parameters:

    @@ -1957,7 +1957,7 @@ and componentDidUpdate will not be called.


    validate#

    validate(value: string): Promise‹void›

    -

    Defined in src/renderer/components/input/input.tsx:119

    +

    Defined in src/renderer/components/input/input.tsx:119

    Parameters:

    @@ -1980,16 +1980,16 @@ and componentDidUpdate will not be called.

    state#

    state: object#

    Overrides PageLayout.state

    -

    Defined in src/renderer/components/input/input.tsx:61

    +

    Defined in src/renderer/components/input/input.tsx:61

    dirty#

    dirty: boolean = !!this.props.dirty

    -

    Defined in src/renderer/components/input/input.tsx:62

    +

    Defined in src/renderer/components/input/input.tsx:62

    errors#

    errors: undefined[] = []

    -

    Defined in src/renderer/components/input/input.tsx:64

    +

    Defined in src/renderer/components/input/input.tsx:64

    valid#

    valid: true = true

    -

    Defined in src/renderer/components/input/input.tsx:63

    +

    Defined in src/renderer/components/input/input.tsx:63

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html index fde95b990e..ca8a940b8d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -1320,7 +1320,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): Promise‹void›

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/+events/kube-event-details.tsx:16

    +

    Defined in src/renderer/components/+events/kube-event-details.tsx:16

    Returns: Promise‹void›


    Optional componentDidUpdate#

    @@ -1487,7 +1487,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/+events/kube-event-details.tsx:20

    +

    Defined in src/renderer/components/+events/kube-event-details.tsx:20

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html index 544e9c26a8..eff85db05d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -1239,7 +1239,7 @@ Should be used with type annotation or static contextType.


    isLoading#

    isLoading: boolean = false

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:70

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:70


    loader#

    loader: IReactionDisposer = reaction(() => [ @@ -1266,11 +1266,11 @@ Should be used with type annotation or static contextType.

    }

    })

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:90

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:90


    loadingError#

    loadingError: React.ReactNode

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:71

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:71


    props#

    props: Readonly‹P› & Readonly‹object›

    @@ -1314,17 +1314,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isCrdInstance#

    get isCrdInstance(): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:85

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:85

    Returns: boolean


    object#

    get object(): any

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:77

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:77

    Returns: any


    path#

    get path(): string

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:73

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:73

    Returns: string

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1611,7 +1611,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:115

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:115

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html index 899df62d03..409a0f09fc 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -1245,7 +1245,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    selectedItem#

    get selectedItem(): any

    -

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:20

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:20

    Returns: any

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1364,7 +1364,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:24

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:24

    Returns: void


    Optional componentDidUpdate#

    @@ -1530,7 +1530,7 @@ lifecycle events from running.


    onDetails#

    onDetails(item: KubeObject): void

    -

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:36

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:36

    Parameters:

    @@ -1551,7 +1551,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:44

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:44

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html index 605f83c1a3..b8623ad3ee 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -1277,17 +1277,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isEditable#

    get isEditable(): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:25

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:25

    Returns: boolean


    isRemovable#

    get isRemovable(): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

    Returns: boolean


    store#

    get store(): KubeObjectStore‹any›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

    Returns: KubeObjectStore‹any›

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1573,18 +1573,18 @@ lifecycle events from running.


    remove#

    remove(): Promise‹void›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:44

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:44

    Returns: Promise‹void›


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

    Returns: Element‹›


    renderRemoveMessage#

    renderRemoveMessage(): Element‹›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

    Returns: Element‹›


    setState#

    @@ -1636,7 +1636,7 @@ and componentDidUpdate will not be called.


    update#

    update(): Promise‹void›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:38

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:38

    Returns: Promise‹void›

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html index b4be02e63a..298086bb05 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -1224,7 +1224,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    defaultHiddenFields: IKubeMetaField[] = [ "uid", "resourceVersion", "selfLink" ]

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:15

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:15

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1509,7 +1509,7 @@ lifecycle events from running.


    isHidden#

    isHidden(field: IKubeMetaField): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:19

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:19

    Parameters:

    @@ -1530,7 +1530,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html index 78dbee51c9..89fa3a798f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -1332,7 +1332,7 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    Returns: Element‹›


    Optional shouldComponentUpdate#

    @@ -1372,19 +1372,19 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    max#

    max: number = 100

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    min#

    min: number = 0

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    precise#

    precise: number = 2

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    value#

    value: number = 0

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html index 7141512fb7..50981f53af 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -1347,11 +1347,11 @@ Should be used with type annotation or static contextType.


    elem#

    elem: HTMLUListElement

    -

    Defined in src/renderer/components/menu/menu.tsx:56

    +

    Defined in src/renderer/components/menu/menu.tsx:56


    Protected items#

    items: object

    -

    Defined in src/renderer/components/menu/menu.tsx:57

    +

    Defined in src/renderer/components/menu/menu.tsx:57

    Type declaration:#

    @@ -1571,7 +1571,7 @@ prevents this from being invoked.


    Protected bindRef#

    bindRef(elem: HTMLUListElement): void

    -

    Defined in src/renderer/components/menu/menu.tsx:242

    +

    Defined in src/renderer/components/menu/menu.tsx:242

    Parameters:

    @@ -1591,7 +1591,7 @@ prevents this from being invoked.


    close#

    close(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:169

    +

    Defined in src/renderer/components/menu/menu.tsx:169

    Returns: void


    Optional componentDidCatch#

    @@ -1624,7 +1624,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/menu/menu.tsx:65

    +

    Defined in src/renderer/components/menu/menu.tsx:65

    Returns: void


    Optional componentDidUpdate#

    @@ -1708,7 +1708,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/menu/menu.tsx:88

    +

    Defined in src/renderer/components/menu/menu.tsx:88

    Returns: void


    Optional componentWillUpdate#

    @@ -1749,7 +1749,7 @@ prevents this from being invoked.


    Protected focusNextItem#

    focusNextItem(reverse: boolean): void

    -

    Defined in src/renderer/components/menu/menu.tsx:107

    +

    Defined in src/renderer/components/menu/menu.tsx:107

    Parameters:

    @@ -1810,12 +1810,12 @@ lifecycle events from running.


    onBlur#

    onBlur(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:236

    +

    Defined in src/renderer/components/menu/menu.tsx:236

    Returns: void


    onClickOutside#

    onClickOutside(evt: MouseEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:224

    +

    Defined in src/renderer/components/menu/menu.tsx:224

    Parameters:

    @@ -1835,12 +1835,12 @@ lifecycle events from running.


    onContextMenu#

    onContextMenu(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:205

    +

    Defined in src/renderer/components/menu/menu.tsx:205

    Returns: void


    onKeyDown#

    onKeyDown(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:178

    +

    Defined in src/renderer/components/menu/menu.tsx:178

    Parameters:

    @@ -1860,7 +1860,7 @@ lifecycle events from running.


    onScrollOutside#

    onScrollOutside(evt: UIEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:214

    +

    Defined in src/renderer/components/menu/menu.tsx:214

    Parameters:

    @@ -1880,18 +1880,18 @@ lifecycle events from running.


    onWindowResize#

    onWindowResize(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:209

    +

    Defined in src/renderer/components/menu/menu.tsx:209

    Returns: void


    open#

    open(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:162

    +

    Defined in src/renderer/components/menu/menu.tsx:162

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu.tsx:250

    +

    Defined in src/renderer/components/menu/menu.tsx:250

    Returns: Element‹›


    setState#

    @@ -1943,7 +1943,7 @@ and componentDidUpdate will not be called.


    toggle#

    toggle(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:174

    +

    Defined in src/renderer/components/menu/menu.tsx:174

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html index e6ee07b318..b1c4aad7be 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -1251,11 +1251,11 @@ Should be used with type annotation or static contextType.


    id#

    id: string = uniqueId("menu_actions_")

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:31

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:31


    isOpen#

    isOpen: boolean = !!this.props.toolbar

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:33

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:33


    props#

    props: Readonly‹MenuActionsProps› & Readonly‹object›

    @@ -1580,18 +1580,18 @@ lifecycle events from running.


    remove#

    remove(): void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:41

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:41

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:82

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:82

    Returns: Element‹›


    renderTriggerIcon#

    renderTriggerIcon(): Element‹›

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:55

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:55

    Returns: Element‹›


    setState#

    @@ -1643,15 +1643,15 @@ and componentDidUpdate will not be called.


    toggle#

    toggle(): void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:35

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:35

    Returns: void

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:25

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:25

    removeConfirmationMessage#

    removeConfirmationMessage:

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html index db6ff8fd1d..02ccf1dfa6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -1223,11 +1223,11 @@

    context#

    context: MenuContextValue

    Overrides PageLayout.context

    -

    Defined in src/renderer/components/menu/menu.tsx:321

    +

    Defined in src/renderer/components/menu/menu.tsx:321


    elem#

    elem: HTMLElement

    -

    Defined in src/renderer/components/menu/menu.tsx:322

    +

    Defined in src/renderer/components/menu/menu.tsx:322


    props#

    props: Readonly‹MenuItemProps› & Readonly‹object›

    @@ -1253,20 +1253,20 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static contextType#

    contextType: Context‹Menu‹›› = MenuContext

    Overrides PageLayout.contextType

    -

    Defined in src/renderer/components/menu/menu.tsx:319

    +

    Defined in src/renderer/components/menu/menu.tsx:319


    Static defaultProps#

    defaultProps: object = defaultPropsMenuItem as object

    -

    Defined in src/renderer/components/menu/menu.tsx:318

    +

    Defined in src/renderer/components/menu/menu.tsx:318

    Accessors#

    isFocusable#

    get isFocusable(): boolean

    -

    Defined in src/renderer/components/menu/menu.tsx:324

    +

    Defined in src/renderer/components/menu/menu.tsx:324

    Returns: boolean


    get isLink(): boolean

    -

    Defined in src/renderer/components/menu/menu.tsx:330

    +

    Defined in src/renderer/components/menu/menu.tsx:330

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1357,7 +1357,7 @@ prevents this from being invoked.


    Protected bindRef#

    bindRef(elem: HTMLElement): void

    -

    Defined in src/renderer/components/menu/menu.tsx:346

    +

    Defined in src/renderer/components/menu/menu.tsx:346

    Parameters:

    @@ -1572,7 +1572,7 @@ lifecycle events from running.


    onClick#

    onClick(evt: MouseEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:334

    +

    Defined in src/renderer/components/menu/menu.tsx:334

    Parameters:

    @@ -1593,7 +1593,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu.tsx:350

    +

    Defined in src/renderer/components/menu/menu.tsx:350

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html index 27cc9c5128..73075bd8ea 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -1253,11 +1253,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:37

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:37

    Accessors#

    options#

    get options(): SelectOption[]

    -

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:48

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:48

    Returns: SelectOption[]

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1376,7 +1376,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:39

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:39

    Returns: void


    Optional componentDidUpdate#

    @@ -1512,7 +1512,7 @@ prevents this from being invoked.


    formatOptionLabel#

    formatOptionLabel(option: SelectOption): object

    -

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:65

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:65

    Parameters:

    @@ -1563,7 +1563,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:77

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:77

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html index 3dc92be0df..2fac799248 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -1216,7 +1216,7 @@ Should be used with type annotation or static contextType.


    elem#

    elem: HTMLElement

    -

    Defined in src/renderer/components/notifications/notifications.tsx:14

    +

    Defined in src/renderer/components/notifications/notifications.tsx:14


    props#

    props: Readonly‹P› & Readonly‹object›

    @@ -1374,7 +1374,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/notifications/notifications.tsx:42

    +

    Defined in src/renderer/components/notifications/notifications.tsx:42

    Returns: void


    Optional componentDidUpdate#

    @@ -1510,7 +1510,7 @@ prevents this from being invoked.


    getMessage#

    getMessage(notification: Notification): (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    -

    Defined in src/renderer/components/notifications/notifications.tsx:60

    +

    Defined in src/renderer/components/notifications/notifications.tsx:60

    Parameters:

    @@ -1561,12 +1561,12 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:70

    +

    Defined in src/renderer/components/notifications/notifications.tsx:70

    Returns: Element‹›


    scrollToLastNotification#

    scrollToLastNotification(): void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:50

    +

    Defined in src/renderer/components/notifications/notifications.tsx:50

    Returns: void


    setState#

    @@ -1618,7 +1618,7 @@ and componentDidUpdate will not be called.


    Static error#

    error(message: NotificationMessage, customOpts: Partial‹Notification›): void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:24

    +

    Defined in src/renderer/components/notifications/notifications.tsx:24

    Parameters:

    @@ -1645,7 +1645,7 @@ and componentDidUpdate will not be called.


    Static info#

    info(message: NotificationMessage, customOpts: Partial‹Notification›): function

    -

    Defined in src/renderer/components/notifications/notifications.tsx:33

    +

    Defined in src/renderer/components/notifications/notifications.tsx:33

    Parameters:

    @@ -1673,7 +1673,7 @@ and componentDidUpdate will not be called.


    Static ok#

    ok(message: NotificationMessage): void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:16

    +

    Defined in src/renderer/components/notifications/notifications.tsx:16

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html index cf41b9c14f..5fc7370ec1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -958,15 +958,15 @@

    Properties#

    Protected autoHideTimers#

    autoHideTimers: Map‹string | number, number› = new Map()

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:28

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:28


    notifications#

    notifications: IObservableArray‹Notification = observable.array([], { deep: false })

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:26

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:26

    Methods#

    add#

    add(notification: Notification): function

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:55

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:55

    Parameters:

    @@ -987,7 +987,7 @@

    addAutoHideTimer#

    addAutoHideTimer(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:34

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:34

    Parameters:

    @@ -1007,7 +1007,7 @@

    getById#

    getById(id: NotificationId): Notification | null

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:30

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:30

    Parameters:

    @@ -1027,7 +1027,7 @@

    remove#

    remove(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:72

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:72

    Parameters:

    @@ -1047,7 +1047,7 @@

    removeAutoHideTimer#

    removeAutoHideTimer(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:47

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:47

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html index e6b0de0c5a..d5578ba19b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -1230,7 +1230,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/layout/page-layout.tsx:29

    +

    Defined in src/renderer/components/layout/page-layout.tsx:29

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1320,7 +1320,7 @@ prevents this from being invoked.


    back#

    back(evt?: MouseEvent | KeyboardEvent): void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:32

    +

    Defined in src/renderer/components/layout/page-layout.tsx:32

    Parameters:

    @@ -1368,7 +1368,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): Promise‹void›

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/layout/page-layout.tsx:40

    +

    Defined in src/renderer/components/layout/page-layout.tsx:40

    Returns: Promise‹void›


    Optional componentDidUpdate#

    @@ -1452,7 +1452,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/layout/page-layout.tsx:44

    +

    Defined in src/renderer/components/layout/page-layout.tsx:44

    Returns: void


    Optional componentWillUpdate#

    @@ -1532,7 +1532,7 @@ lifecycle events from running.


    onEscapeKey#

    onEscapeKey(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:48

    +

    Defined in src/renderer/components/layout/page-layout.tsx:48

    Parameters:

    @@ -1553,7 +1553,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:59

    +

    Defined in src/renderer/components/layout/page-layout.tsx:59

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html index d3dbe1fcc6..0236ed5bef 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -1389,7 +1389,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:53

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:53

    Returns: void


    Optional componentDidUpdate#

    @@ -1473,7 +1473,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

    Returns: void


    Optional componentWillUpdate#

    @@ -1553,7 +1553,7 @@ lifecycle events from running.


    getTableRow#

    getTableRow(uid: string): Element‹›

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

    Parameters:

    @@ -1574,12 +1574,12 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

    Returns: Element‹›


    renderCpuUsage#

    renderCpuUsage(id: string, usage: number): string | 0 | Element‹›

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

    Parameters:

    @@ -1603,7 +1603,7 @@ lifecycle events from running.


    renderMemoryUsage#

    renderMemoryUsage(id: string, usage: number): string | 0 | Element‹›

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

    Parameters:

    @@ -1674,10 +1674,10 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

    showTitle#

    showTitle: true = true

    -

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html index 8c27b51a49..903566181d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -1503,12 +1503,12 @@ lifecycle events from running.


    onChange#

    onChange(): void

    -

    Defined in src/renderer/components/radio/radio.tsx:52

    +

    Defined in src/renderer/components/radio/radio.tsx:52

    Returns: void


    onKeyDown#

    onKeyDown(e: KeyboardEvent‹any›): void

    -

    Defined in src/renderer/components/radio/radio.tsx:60

    +

    Defined in src/renderer/components/radio/radio.tsx:60

    Parameters:

    @@ -1529,7 +1529,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/radio/radio.tsx:70

    +

    Defined in src/renderer/components/radio/radio.tsx:70

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html index 13c9b00da1..dd847a5d19 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -1486,7 +1486,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/radio/radio.tsx:17

    +

    Defined in src/renderer/components/radio/radio.tsx:17

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.select/index.html b/latest/extensions/api/classes/_renderer_api_components_.select/index.html index ed8a653feb..c2963f1e6f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.select/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.select/index.html @@ -1336,17 +1336,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    options#

    get options(): SelectOption[]

    -

    Defined in src/renderer/components/select/select.tsx:71

    +

    Defined in src/renderer/components/select/select.tsx:71

    Returns: SelectOption[]


    selectedOption#

    get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

    -

    Defined in src/renderer/components/select/select.tsx:57

    +

    Defined in src/renderer/components/select/select.tsx:57

    Returns: SelectOption‹any› | SelectOption‹any›[]


    theme#

    get theme(): "dark" | "light" | "outlined"

    -

    Defined in src/renderer/components/select/select.tsx:42

    +

    Defined in src/renderer/components/select/select.tsx:42

    Returns: "dark" | "light" | "outlined"

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1632,7 +1632,7 @@ lifecycle events from running.


    Protected isValidOption#

    isValidOption(opt: SelectOption | any): boolean

    -

    Defined in src/renderer/components/select/select.tsx:53

    +

    Defined in src/renderer/components/select/select.tsx:53

    Parameters:

    @@ -1652,7 +1652,7 @@ lifecycle events from running.


    onChange#

    onChange(value: SelectOption, meta: ActionMeta‹any›): void

    -

    Defined in src/renderer/components/select/select.tsx:84

    +

    Defined in src/renderer/components/select/select.tsx:84

    Parameters:

    @@ -1676,7 +1676,7 @@ lifecycle events from running.


    onKeyDown#

    onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    -

    Defined in src/renderer/components/select/select.tsx:91

    +

    Defined in src/renderer/components/select/select.tsx:91

    Parameters:

    @@ -1697,7 +1697,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/select/select.tsx:100

    +

    Defined in src/renderer/components/select/select.tsx:100

    Returns: Element‹›


    setState#

    @@ -1749,16 +1749,16 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/select/select.tsx:36

    +

    Defined in src/renderer/components/select/select.tsx:36

    autoConvertOptions#

    autoConvertOptions: true = true

    -

    Defined in src/renderer/components/select/select.tsx:37

    +

    Defined in src/renderer/components/select/select.tsx:37

    menuPlacement: "auto" = "auto"

    -

    Defined in src/renderer/components/select/select.tsx:39

    +

    Defined in src/renderer/components/select/select.tsx:39

    menuPortalTarget: HTMLElement = document.body

    -

    Defined in src/renderer/components/select/select.tsx:38

    +

    Defined in src/renderer/components/select/select.tsx:38

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html index 6ee4e8b0f9..e16c3f63f8 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -1214,7 +1214,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/slider/slider.tsx:21

    +

    Defined in src/renderer/components/slider/slider.tsx:21

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1500,7 +1500,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/slider/slider.tsx:30

    +

    Defined in src/renderer/components/slider/slider.tsx:30

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html index 358bbdb3c1..d96290de27 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -1538,7 +1538,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/spinner/spinner.tsx:18

    +

    Defined in src/renderer/components/spinner/spinner.tsx:18

    Returns: Element‹›


    setState#

    @@ -1590,13 +1590,13 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/spinner/spinner.tsx:13

    +

    Defined in src/renderer/components/spinner/spinner.tsx:13

    center#

    center: boolean = false

    -

    Defined in src/renderer/components/spinner/spinner.tsx:15

    +

    Defined in src/renderer/components/spinner/spinner.tsx:15

    singleColor#

    singleColor: boolean = true

    -

    Defined in src/renderer/components/spinner/spinner.tsx:14

    +

    Defined in src/renderer/components/spinner/spinner.tsx:14

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html index 00d107983d..a584e145f7 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    +

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html index 8e4f40bd64..a578db7a18 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -1486,7 +1486,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/stepper/stepper.tsx:15

    +

    Defined in src/renderer/components/stepper/stepper.tsx:15

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html index 1a6e51dfc7..c0c055fd07 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -1120,19 +1120,19 @@

    Properties#

    context#

    context: TabsContextValue

    -

    Defined in src/renderer/components/tabs/tabs.tsx:65

    +

    Defined in src/renderer/components/tabs/tabs.tsx:65


    elem#

    elem: HTMLElement

    -

    Defined in src/renderer/components/tabs/tabs.tsx:66

    +

    Defined in src/renderer/components/tabs/tabs.tsx:66


    Static contextType#

    contextType: Context‹TabsContextValue‹any›› = TabsContext

    -

    Defined in src/renderer/components/tabs/tabs.tsx:64

    +

    Defined in src/renderer/components/tabs/tabs.tsx:64

    Accessors#

    isActive#

    get isActive(): boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:68

    +

    Defined in src/renderer/components/tabs/tabs.tsx:68

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1223,7 +1223,7 @@ prevents this from being invoked.


    Protected bindRef#

    bindRef(elem: HTMLElement): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:121

    +

    Defined in src/renderer/components/tabs/tabs.tsx:121

    Parameters:

    @@ -1271,7 +1271,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/tabs/tabs.tsx:114

    +

    Defined in src/renderer/components/tabs/tabs.tsx:114

    Returns: void


    Optional componentDidUpdate#

    @@ -1398,7 +1398,7 @@ prevents this from being invoked.


    focus#

    focus(): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:74

    +

    Defined in src/renderer/components/tabs/tabs.tsx:74

    Returns: void


    Optional getSnapshotBeforeUpdate#

    @@ -1433,7 +1433,7 @@ lifecycle events from running.


    onClick#

    onClick(evt: MouseEvent‹HTMLElement›): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:86

    +

    Defined in src/renderer/components/tabs/tabs.tsx:86

    Parameters:

    @@ -1453,7 +1453,7 @@ lifecycle events from running.


    onFocus#

    onFocus(evt: FocusEvent‹HTMLElement›): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:96

    +

    Defined in src/renderer/components/tabs/tabs.tsx:96

    Parameters:

    @@ -1473,7 +1473,7 @@ lifecycle events from running.


    onKeyDown#

    onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:104

    +

    Defined in src/renderer/components/tabs/tabs.tsx:104

    Parameters:

    @@ -1493,12 +1493,12 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/tabs/tabs.tsx:125

    +

    Defined in src/renderer/components/tabs/tabs.tsx:125

    Returns: Element‹›


    scrollIntoView#

    scrollIntoView(): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:78

    +

    Defined in src/renderer/components/tabs/tabs.tsx:78

    Returns: void


    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.table/index.html b/latest/extensions/api/classes/_renderer_api_components_.table/index.html index a30937e052..424cb44519 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.table/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.table/index.html @@ -847,6 +847,13 @@ Properties + + +
  • + + Accessors + +
  • @@ -915,13 +922,6 @@ refs -
  • - -
  • - - sortParams - -
  • @@ -941,6 +941,26 @@ +
  • + +
  • + + Accessors + + + +
  • @@ -980,8 +1000,8 @@
  • - - Optional componentDidMount + + componentDidMount
  • @@ -1192,17 +1212,20 @@
  • context
  • props
  • refs
  • -
  • sortParams
  • state
  • contextType
  • +

    Accessors#

    +

    Methods#


    -

    sortParams#

    -

    sortParams: Partial‹TableSortParams = Object.assign( - this.props.sortSyncWithUrl ? { - sortBy: sortByUrlParam.get(), - orderBy: orderByUrlParam.get(), - } : {}, - this.props.sortByDefault, - )

    -

    Defined in src/renderer/components/table/table.tsx:65

    -

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    @@ -1334,6 +1347,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    }

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    sortParams#

    +

    get sortParams(): object

    +

    Defined in src/renderer/components/table/table.tsx:75

    +

    Returns: object

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1448,11 +1466,10 @@ the entire component tree to unmount.

    Returns: void


    -

    Optional componentDidMount#

    +

    componentDidMount#

    componentDidMount(): void

    -

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:619

    -

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/table/table.tsx:67

    Returns: void


    Optional componentDidUpdate#

    @@ -1618,7 +1635,7 @@ lifecycle events from running.


    getSorted#

    getSorted(items: any[]): any[]

    -

    Defined in src/renderer/components/table/table.tsx:107

    +

    Defined in src/renderer/components/table/table.tsx:113

    Parameters:

    @@ -1638,7 +1655,7 @@ lifecycle events from running.


    Protected onSort#

    onSort(__namedParameters: object): void

    -

    Defined in src/renderer/components/table/table.tsx:115

    +

    Defined in src/renderer/components/table/table.tsx:121

    Parameters:

    __namedParameters: object

    @@ -1664,17 +1681,17 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/table/table.tsx:187

    +

    Defined in src/renderer/components/table/table.tsx:193

    Returns: Element‹›


    renderHead#

    renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

    -

    Defined in src/renderer/components/table/table.tsx:73

    +

    Defined in src/renderer/components/table/table.tsx:79

    Returns: ReactElement‹TableHeadProps‹›, string | function | object›


    renderRows#

    renderRows(): object

    -

    Defined in src/renderer/components/table/table.tsx:142

    +

    Defined in src/renderer/components/table/table.tsx:148

    Returns: object


    setState#

    @@ -1726,7 +1743,7 @@ and componentDidUpdate will not be called.


    sort#

    sort(colName: TableSortBy): void

    -

    Defined in src/renderer/components/table/table.tsx:130

    +

    Defined in src/renderer/components/table/table.tsx:136

    Parameters:

    @@ -1746,22 +1763,22 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/table/table.tsx:57

    +

    Defined in src/renderer/components/table/table.tsx:59

    autoSize#

    autoSize: true = true

    -

    Defined in src/renderer/components/table/table.tsx:59

    +

    Defined in src/renderer/components/table/table.tsx:61

    rowLineHeight#

    rowLineHeight: string = "17px"

    -

    Defined in src/renderer/components/table/table.tsx:61

    +

    Defined in src/renderer/components/table/table.tsx:63

    rowPadding#

    rowPadding: string = "8px"

    -

    Defined in src/renderer/components/table/table.tsx:60

    +

    Defined in src/renderer/components/table/table.tsx:62

    scrollable#

    scrollable: true = true

    -

    Defined in src/renderer/components/table/table.tsx:58

    +

    Defined in src/renderer/components/table/table.tsx:60

    sortSyncWithUrl#

    sortSyncWithUrl: true = true

    -

    Defined in src/renderer/components/table/table.tsx:62

    +

    Defined in src/renderer/components/table/table.tsx:64

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html index 1752786291..a24f2d73c4 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -1261,7 +1261,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isSortable#

    get isSortable(): boolean

    -

    Defined in src/renderer/components/table/table-cell.tsx:37

    +

    Defined in src/renderer/components/table/table-cell.tsx:37

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1547,7 +1547,7 @@ lifecycle events from running.


    onClick#

    onClick(evt: MouseEvent‹HTMLDivElement›): void

    -

    Defined in src/renderer/components/table/table-cell.tsx:27

    +

    Defined in src/renderer/components/table/table-cell.tsx:27

    Parameters:

    @@ -1568,17 +1568,17 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/table/table-cell.tsx:67

    +

    Defined in src/renderer/components/table/table-cell.tsx:67

    Returns: Element‹›


    renderCheckbox#

    renderCheckbox(): Element‹›

    -

    Defined in src/renderer/components/table/table-cell.tsx:58

    +

    Defined in src/renderer/components/table/table-cell.tsx:58

    Returns: Element‹›


    renderSortIcon#

    renderSortIcon(): Element‹›

    -

    Defined in src/renderer/components/table/table-cell.tsx:43

    +

    Defined in src/renderer/components/table/table-cell.tsx:43

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html index fe32b7c839..ac59412ee0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -1533,7 +1533,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/table/table-head.tsx:20

    +

    Defined in src/renderer/components/table/table-head.tsx:20

    Returns: Element‹›


    setState#

    @@ -1585,10 +1585,10 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/table/table-head.tsx:16

    +

    Defined in src/renderer/components/table/table-head.tsx:16

    sticky#

    sticky: true = true

    -

    Defined in src/renderer/components/table/table-head.tsx:17

    +

    Defined in src/renderer/components/table/table-head.tsx:17

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html index d9ff65f99f..97820a17a8 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/table/table-row.tsx:20

    +

    Defined in src/renderer/components/table/table-row.tsx:20

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html index 9121865e70..5460b8bc9c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -1033,7 +1033,7 @@

    Properties#

    elem#

    elem: HTMLElement

    -

    Defined in src/renderer/components/tabs/tabs.tsx:25

    +

    Defined in src/renderer/components/tabs/tabs.tsx:25

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    @@ -1123,7 +1123,7 @@ prevents this from being invoked.


    Protected bindRef#

    bindRef(elem: HTMLElement): void

    -

    Defined in src/renderer/components/tabs/tabs.tsx:28

    +

    Defined in src/renderer/components/tabs/tabs.tsx:28

    Parameters:

    @@ -1329,7 +1329,7 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

    Defined in src/renderer/components/tabs/tabs.tsx:32

    +

    Defined in src/renderer/components/tabs/tabs.tsx:32

    Returns: Element‹›


    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html index 9c9ce40dd2..bf95b8d071 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -1270,7 +1270,7 @@

    Properties#

    activePosition#

    activePosition: TooltipPosition

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:51

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:51


    context#

    context: any

    @@ -1289,11 +1289,11 @@ Should be used with type annotation or static contextType.


    elem#

    elem: HTMLElement

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:50

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:50


    isVisible#

    isVisible: boolean = !!this.props.visible

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:52

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:52


    props#

    props: Readonly‹TooltipProps› & Readonly‹object›

    @@ -1337,16 +1337,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:48

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:48

    Accessors#

    hoverTarget#

    get hoverTarget(): HTMLElement

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:58

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:58

    Returns: HTMLElement


    targetElem#

    get targetElem(): HTMLElement

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:54

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:54

    Returns: HTMLElement

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1437,7 +1437,7 @@ prevents this from being invoked.


    bindRef#

    bindRef(elem: HTMLElement): void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:198

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:198

    Parameters:

    @@ -1485,7 +1485,7 @@ the entire component tree to unmount.

    componentDidMount#

    componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:66

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:66

    Returns: void


    Optional componentDidUpdate#

    @@ -1569,7 +1569,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:71

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:71

    Returns: void


    Optional componentWillUpdate#

    @@ -1619,7 +1619,7 @@ prevents this from being invoked.


    Protected getPosition#

    getPosition(position: TooltipPosition, tooltipBounds: DOMRect, targetBounds: DOMRect): object

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:145

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:145

    Parameters:

    @@ -1691,28 +1691,28 @@ lifecycle events from running.


    Protected onEnterTarget#

    onEnterTarget(): void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:77

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:77

    Returns: void


    Protected onLeaveTarget#

    onLeaveTarget(): void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:83

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:83

    Returns: void


    refreshPosition#

    refreshPosition(): void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:88

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:88

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:202

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:202

    Returns: Element‹›


    Protected setPosition#

    setPosition(pos: object): void

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:138

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:138

    Parameters:

    pos: object

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html index c740985ab2..20ca63b4d5 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -1331,10 +1331,10 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    step#

    get step(): number

    -

    Defined in src/renderer/components/wizard/wizard.tsx:56

    +

    Defined in src/renderer/components/wizard/wizard.tsx:56

    Returns: number

    set step(step: number): void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:60

    +

    Defined in src/renderer/components/wizard/wizard.tsx:60

    Parameters:

    @@ -1354,7 +1354,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    steps#

    get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

    -

    Defined in src/renderer/components/wizard/wizard.tsx:34

    +

    Defined in src/renderer/components/wizard/wizard.tsx:34

    Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1601,7 +1601,7 @@ prevents this from being invoked.


    firstStep#

    firstStep(): any

    -

    Defined in src/renderer/components/wizard/wizard.tsx:77

    +

    Defined in src/renderer/components/wizard/wizard.tsx:77

    Returns: any


    forceUpdate#

    @@ -1645,7 +1645,7 @@ lifecycle events from running.


    Protected getValidStep#

    getValidStep(step: number): number

    -

    Defined in src/renderer/components/wizard/wizard.tsx:71

    +

    Defined in src/renderer/components/wizard/wizard.tsx:71

    Parameters:

    @@ -1665,33 +1665,33 @@ lifecycle events from running.


    isFirstStep#

    isFirstStep(): boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:75

    +

    Defined in src/renderer/components/wizard/wizard.tsx:75

    Returns: boolean


    isLastStep#

    isLastStep(): boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:76

    +

    Defined in src/renderer/components/wizard/wizard.tsx:76

    Returns: boolean


    lastStep#

    lastStep(): any

    -

    Defined in src/renderer/components/wizard/wizard.tsx:80

    +

    Defined in src/renderer/components/wizard/wizard.tsx:80

    Returns: any


    nextStep#

    nextStep(): any

    -

    Defined in src/renderer/components/wizard/wizard.tsx:78

    +

    Defined in src/renderer/components/wizard/wizard.tsx:78

    Returns: any


    prevStep#

    prevStep(): any

    -

    Defined in src/renderer/components/wizard/wizard.tsx:79

    +

    Defined in src/renderer/components/wizard/wizard.tsx:79

    Returns: any


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:82

    +

    Defined in src/renderer/components/wizard/wizard.tsx:82

    Returns: Element‹›


    setState#

    @@ -1744,10 +1744,10 @@ and componentDidUpdate will not be called.

    state#

    state: object#

    Overrides PageLayout.state

    -

    Defined in src/renderer/components/wizard/wizard.tsx:30

    +

    Defined in src/renderer/components/wizard/wizard.tsx:30

    step#

    step: number = this.getValidStep(this.props.step)

    -

    Defined in src/renderer/components/wizard/wizard.tsx:31

    +

    Defined in src/renderer/components/wizard/wizard.tsx:31

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html index 2740a1065b..58097d02ce 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -1488,7 +1488,7 @@ lifecycle events from running.

    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:18

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:18

    Returns: Element‹›


    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html index 3e0b60a439..e0f42c815e 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -1258,7 +1258,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    state#

    state: WizardStepState

    Overrides PageLayout.state

    -

    Defined in src/renderer/components/wizard/wizard.tsx:136

    +

    Defined in src/renderer/components/wizard/wizard.tsx:136


    Static Optional contextType#

    contextType? : Context‹any›

    @@ -1480,7 +1480,7 @@ prevents this from being invoked.

    componentWillUnmount#

    componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/wizard/wizard.tsx:143

    +

    Defined in src/renderer/components/wizard/wizard.tsx:143

    Returns: void


    Optional componentWillUpdate#

    @@ -1560,23 +1560,23 @@ lifecycle events from running.


    next#

    next(): void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:154

    +

    Defined in src/renderer/components/wizard/wizard.tsx:154

    Returns: void


    prev#

    prev(): void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:147

    +

    Defined in src/renderer/components/wizard/wizard.tsx:147

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:194

    +

    Defined in src/renderer/components/wizard/wizard.tsx:194

    Returns: Element‹›


    renderLoading#

    renderLoading(): Element‹›

    -

    Defined in src/renderer/components/wizard/wizard.tsx:186

    +

    Defined in src/renderer/components/wizard/wizard.tsx:186

    Returns: Element‹›


    setState#

    @@ -1628,15 +1628,15 @@ and componentDidUpdate will not be called.


    submit#

    submit(): void

    -

    Defined in src/renderer/components/wizard/wizard.tsx:177

    +

    Defined in src/renderer/components/wizard/wizard.tsx:177

    Returns: void

    Object literals#

    Static defaultProps#

    defaultProps: object#

    -

    Defined in src/renderer/components/wizard/wizard.tsx:139

    +

    Defined in src/renderer/components/wizard/wizard.tsx:139

    scrollable#

    scrollable: true = true

    -

    Defined in src/renderer/components/wizard/wizard.tsx:140

    +

    Defined in src/renderer/components/wizard/wizard.tsx:140

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html index e870862acf..49697044d0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -1199,7 +1199,7 @@

    constructor#

    + new ClusterRole(data: KubeJsonApiData): ClusterRole

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1220,53 +1220,53 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    rules#

    rules: object[]

    Inherited from Role.rules

    -

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9


    Optional status#

    status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:102

    +

    Defined in src/renderer/api/kube-object.ts:102


    Static apiBase#

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

    Overrides Role.apiBase

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9


    Static kind#

    kind: string = "ClusterRole"

    Overrides Role.kind

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7


    Static namespaced#

    namespaced: boolean = false

    Overrides Role.namespaced

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    Accessors#

    get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:104

    +

    Defined in src/renderer/api/kube-object.ts:104

    Returns: string

    Methods#

    delete#

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:193

    +

    Defined in src/renderer/api/kube-object.ts:193

    Parameters:

    @@ -1287,7 +1287,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1320,7 +1320,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1343,73 +1343,73 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getRules#

    getRules(): object[]

    Inherited from Role.getRules

    -

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    Returns: object[]


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1432,7 +1432,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1453,7 +1453,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1474,7 +1474,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1495,7 +1495,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1516,7 +1516,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html index 83f35f2a6f..4df802662c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -1215,7 +1215,7 @@

    constructor#

    + new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1236,22 +1236,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    roleRef#

    roleRef: object

    Inherited from RoleBinding.roleRef

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    Type declaration:#

    @@ -1320,7 +1320,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1353,7 +1353,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1376,79 +1376,79 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSubjectNames#

    getSubjectNames(): string

    Inherited from RoleBinding.getSubjectNames

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    Returns: string


    getSubjects#

    getSubjects(): IRoleBindingSubject[]

    Inherited from RoleBinding.getSubjects

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    Returns: IRoleBindingSubject[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1471,7 +1471,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1492,7 +1492,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1513,7 +1513,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1534,7 +1534,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1555,7 +1555,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html index 24a8c90be4..85a861b8bc 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -1201,7 +1201,7 @@

    constructor#

    + new ConfigMap(data: KubeJsonApiData): ConfigMap

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    Parameters:

    @@ -1222,11 +1222,11 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    data#

    data: object

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    Type declaration:#

    @@ -1291,7 +1291,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1324,7 +1324,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1347,72 +1347,72 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getKeys#

    getKeys(): string[]

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    Returns: string[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1435,7 +1435,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1456,7 +1456,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1477,7 +1477,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1498,7 +1498,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1519,7 +1519,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html index 589fefd12c..749d15c393 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new ConfigMapsStore(): ConfigMapsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: ConfigMapsStore

    Properties#

    api#

    api: KubeApiConfigMap‹›› = configMapApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

    +

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): ConfigMap[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: ConfigMap[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): ConfigMap[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ConfigMap[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: ConfigMap): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: ConfigMap[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): ConfigMap[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): ConfigMap[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): ConfigMap

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): ConfigMap

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): ConfigMap[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: ConfigMap[]


    Optional getStatuses#

    getStatuses(items: ConfigMap[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: ConfigMap): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: ConfigMap[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹ConfigMap

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | ConfigMap[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹ConfigMap

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹ConfigMap[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: ConfigMap[], __namedParameters: object): ConfigMap[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: ConfigMap[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: ConfigMap): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: ConfigMap, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: ConfigMap

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: ConfigMap): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: ConfigMap[], sorting?: function[], order?: "asc" | "desc"): ConfigMap[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: ConfigMap): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: ConfigMap[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: ConfigMap): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: ConfigMap, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: ConfigMap

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html index 0ee9d5b512..51b27ae241 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -1397,7 +1397,7 @@

    constructor#

    + new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    Parameters:

    @@ -1418,87 +1418,87 @@

    api#

    api: KubeApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): T[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: T[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): T[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: T[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1521,7 +1521,7 @@

    create#

    create(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1549,7 +1549,7 @@

    createItem(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1576,7 +1576,7 @@

    Protected defaultSorting#

    defaultSorting(item: T): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1597,7 +1597,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: T[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1618,7 +1618,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): T[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1646,7 +1646,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1667,7 +1667,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): T[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1689,7 +1689,7 @@

    getByName(name: string, namespace?: string): T

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1714,7 +1714,7 @@

    getByPath#

    getByPath(path: string): T

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1735,7 +1735,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1756,13 +1756,13 @@

    getItems#

    getItems(): T[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: T[]


    Optional getStatuses#

    getStatuses(items: T[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1783,20 +1783,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: T): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1817,7 +1817,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: T[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1840,7 +1840,7 @@

    load#

    load(params: object): Promise‹T›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1867,7 +1867,7 @@

    loadAll(options: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1893,7 +1893,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1915,7 +1915,7 @@

    loadItem(params: object): Promise‹T›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1942,7 +1942,7 @@

    loadItems(__namedParameters: object): Promise‹T[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1968,7 +1968,7 @@

    Protected mergeItems#

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: T[]

    Default value __namedParameters: object= {}

    @@ -2008,7 +2008,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2038,7 +2038,7 @@

    remove#

    remove(item: T): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2059,7 +2059,7 @@

    Protected removeItem#

    removeItem(item: T, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: T

    request: function

    @@ -2070,19 +2070,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2103,13 +2103,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: T): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2130,7 +2130,7 @@

    Protected sortItems#

    sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2164,7 +2164,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2187,7 +2187,7 @@

    toggleSelection#

    toggleSelection(item: T): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2208,7 +2208,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: T[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2231,7 +2231,7 @@

    unselect#

    unselect(item: T): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2252,7 +2252,7 @@

    update#

    update(item: T, data: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2277,13 +2277,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: T, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: T

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html index 35f85482e8..40fda370a5 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -1412,98 +1412,98 @@

    constructor#

    + new CRDStore(): CRDStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    Returns: CRDStore

    Properties#

    api#

    api: KubeApiCustomResourceDefinition‹›› = crdApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): CustomResourceDefinition[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: CustomResourceDefinition[]


    groups#

    get groups(): object

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    Returns: object


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): CustomResourceDefinition[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: CustomResourceDefinition[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1526,7 +1526,7 @@

    create#

    create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1554,7 +1554,7 @@

    createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1581,7 +1581,7 @@

    Protected defaultSorting#

    defaultSorting(item: CustomResourceDefinition): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1602,7 +1602,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1623,7 +1623,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): CustomResourceDefinition[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1650,7 +1650,7 @@

    getByGroup#

    getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    Parameters:

    @@ -1675,7 +1675,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1696,7 +1696,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): CustomResourceDefinition[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByName(name: string, namespace?: string): CustomResourceDefinition

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1742,7 +1742,7 @@

    getByObject#

    getByObject(obj: KubeObject): CustomResourceDefinition‹›

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    Parameters:

    @@ -1763,7 +1763,7 @@

    getByPath#

    getByPath(path: string): CustomResourceDefinition

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1784,7 +1784,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1805,13 +1805,13 @@

    getItems#

    getItems(): CustomResourceDefinition[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: CustomResourceDefinition[]


    Optional getStatuses#

    getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1832,20 +1832,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: CustomResourceDefinition): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1866,7 +1866,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1889,7 +1889,7 @@

    load#

    load(params: object): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1916,7 +1916,7 @@

    loadAll(options: object): Promise‹void | CustomResourceDefinition[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1942,7 +1942,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1964,7 +1964,7 @@

    loadItem(params: object): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1991,7 +1991,7 @@

    loadItems(__namedParameters: object): Promise‹CustomResourceDefinition[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2017,7 +2017,7 @@

    Protected mergeItems#

    mergeItems(partialItems: CustomResourceDefinition[], __namedParameters: object): CustomResourceDefinition[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: CustomResourceDefinition[]

    Default value __namedParameters: object= {}

    @@ -2057,7 +2057,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2087,7 +2087,7 @@

    remove#

    remove(item: CustomResourceDefinition): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2108,7 +2108,7 @@

    Protected removeItem#

    removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: CustomResourceDefinition

    request: function

    @@ -2119,19 +2119,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2152,13 +2152,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2179,7 +2179,7 @@

    Protected sortItems#

    sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    Parameters:

    @@ -2201,7 +2201,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2224,7 +2224,7 @@

    toggleSelection#

    toggleSelection(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2245,7 +2245,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2268,7 +2268,7 @@

    unselect#

    unselect(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2289,7 +2289,7 @@

    update#

    update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2314,13 +2314,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: CustomResourceDefinition

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html index 91d4fa200c..dab5c5de11 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -1233,7 +1233,7 @@

    constructor#

    + new CronJob(data: KubeJsonApiData): CronJob

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1254,17 +1254,17 @@

    apiVersion#

    apiVersion: string

    Overrides KubeObject.apiVersion

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:47

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:47


    kind#

    kind: string

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:46

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:46


    metadata#

    metadata: object

    Overrides KubeObject.metadata

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:48

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:48

    Type declaration:#

    @@ -1422,7 +1422,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1455,7 +1455,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1478,92 +1478,92 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getLastScheduleTime#

    getLastScheduleTime(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:103

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:103

    Returns: string


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSchedule#

    getSchedule(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:110

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:110

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSuspendFlag#

    getSuspendFlag(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:99

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:99

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    isNeverRun#

    isNeverRun(): boolean

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:114

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:114

    Returns: boolean


    isSuspend#

    isSuspend(): boolean

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:126

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:126

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1586,7 +1586,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1607,7 +1607,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1628,7 +1628,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1649,7 +1649,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1670,7 +1670,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html index 228d467d9c..b096ee935c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -1396,93 +1396,93 @@

    constructor#

    + new CronJobStore(): CronJobStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: CronJobStore

    Properties#

    api#

    api: CronJobApi‹› = cronJobApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): CronJob[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: CronJob[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): CronJob[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: CronJob[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1505,7 +1505,7 @@

    create#

    create(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1533,7 +1533,7 @@

    createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1560,7 +1560,7 @@

    Protected defaultSorting#

    defaultSorting(item: CronJob): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1581,7 +1581,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: CronJob[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1601,7 +1601,7 @@

    getActiveJobsNum#

    getActiveJobsNum(cronJob: CronJob): number

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    Parameters:

    @@ -1622,7 +1622,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): CronJob[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1650,7 +1650,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1671,7 +1671,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): CronJob[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1693,7 +1693,7 @@

    getByName(name: string, namespace?: string): CronJob

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByPath#

    getByPath(path: string): CronJob

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1739,7 +1739,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1760,13 +1760,13 @@

    getItems#

    getItems(): CronJob[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: CronJob[]


    getStatuses#

    getStatuses(cronJobs?: CronJob[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    Parameters:

    @@ -1795,20 +1795,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: CronJob): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1829,7 +1829,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: CronJob[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1852,7 +1852,7 @@

    load#

    load(params: object): Promise‹CronJob

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1879,7 +1879,7 @@

    loadAll(options: object): Promise‹void | CronJob[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1905,7 +1905,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1927,7 +1927,7 @@

    loadItem(params: object): Promise‹CronJob

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1954,7 +1954,7 @@

    loadItems(__namedParameters: object): Promise‹CronJob[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1980,7 +1980,7 @@

    Protected mergeItems#

    mergeItems(partialItems: CronJob[], __namedParameters: object): CronJob[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: CronJob[]

    Default value __namedParameters: object= {}

    @@ -2020,7 +2020,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2050,7 +2050,7 @@

    remove#

    remove(item: CronJob): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2071,7 +2071,7 @@

    Protected removeItem#

    removeItem(item: CronJob, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: CronJob

    request: function

    @@ -2082,19 +2082,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2115,13 +2115,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: CronJob): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2142,7 +2142,7 @@

    Protected sortItems#

    sortItems(items: CronJob[], sorting?: function[], order?: "asc" | "desc"): CronJob[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2176,7 +2176,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2199,7 +2199,7 @@

    toggleSelection#

    toggleSelection(item: CronJob): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2220,7 +2220,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: CronJob[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2243,7 +2243,7 @@

    unselect#

    unselect(item: CronJob): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2264,7 +2264,7 @@

    update#

    update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2289,13 +2289,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: CronJob, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: CronJob

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html index c920ec16ac..9e7acfb143 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -1313,7 +1313,7 @@

    constructor#

    + new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1334,21 +1334,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    Type declaration:#

    @@ -1471,7 +1471,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1504,7 +1504,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1526,46 +1526,46 @@

    getConditions#

    getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    Returns: object[]


    getConversion#

    getConversion(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    Returns: string


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getGroup#

    getGroup(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    Returns: string


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNames#

    getNames(): object

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    Returns: object

    @@ -1623,77 +1623,77 @@

    getResourceApiBase#

    getResourceApiBase(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    Returns: string


    getResourceKind#

    getResourceKind(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    Returns: string


    getResourceTitle#

    getResourceTitle(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    Returns: string


    getResourceUrl#

    getResourceUrl(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    Returns: string


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getScope#

    getScope(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getStoredVersions#

    getStoredVersions(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getValidation#

    getValidation(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    Returns: string


    getVersion#

    getVersion(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    Returns: string


    isNamespaced#

    isNamespaced(): boolean

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1716,7 +1716,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1737,7 +1737,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1758,7 +1758,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1779,7 +1779,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1800,7 +1800,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html index d7cfd8b127..302cb1e18a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -1249,7 +1249,7 @@

    constructor#

    + new DaemonSet(data: KubeJsonApiData): DaemonSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1270,22 +1270,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    Type declaration:#

    @@ -1442,19 +1442,19 @@

    getAffinity#

    getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity


    getAffinityNumber#

    getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1487,7 +1487,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1510,96 +1510,96 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getImages#

    getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    Returns: string[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeSelectors#

    getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSelectors#

    getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]


    getTemplateLabels#

    getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTolerations#

    getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1622,7 +1622,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1664,7 +1664,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1685,7 +1685,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1706,7 +1706,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html index 7d6eb470c6..25e92c274b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -1412,97 +1412,97 @@

    constructor#

    + new DaemonSetStore(): DaemonSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: DaemonSetStore

    Properties#

    api#

    api: KubeApiDaemonSet‹›› = daemonSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): DaemonSet[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: DaemonSet[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): DaemonSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: DaemonSet[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1525,7 +1525,7 @@

    create#

    create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1553,7 +1553,7 @@

    createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1580,7 +1580,7 @@

    Protected defaultSorting#

    defaultSorting(item: DaemonSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1601,7 +1601,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: DaemonSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1622,7 +1622,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): DaemonSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1650,7 +1650,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1671,7 +1671,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): DaemonSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1693,7 +1693,7 @@

    getByName(name: string, namespace?: string): DaemonSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByPath#

    getByPath(path: string): DaemonSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1738,7 +1738,7 @@

    getChildPods#

    getChildPods(daemonSet: DaemonSet): Pod[]

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    Parameters:

    @@ -1759,7 +1759,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1780,13 +1780,13 @@

    getItems#

    getItems(): DaemonSet[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: DaemonSet[]


    getStatuses#

    getStatuses(daemonSets?: DaemonSet[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    Parameters:

    @@ -1818,20 +1818,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: DaemonSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1852,7 +1852,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: DaemonSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1875,7 +1875,7 @@

    load#

    load(params: object): Promise‹DaemonSet

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1902,7 +1902,7 @@

    loadAll(options: object): Promise‹void | DaemonSet[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1928,7 +1928,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1950,7 +1950,7 @@

    loadItem(params: object): Promise‹DaemonSet

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1977,7 +1977,7 @@

    loadItems(__namedParameters: object): Promise‹DaemonSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2002,7 +2002,7 @@

    loadMetrics#

    loadMetrics(daemonSet: DaemonSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    Parameters:

    @@ -2023,7 +2023,7 @@

    Protected mergeItems#

    mergeItems(partialItems: DaemonSet[], __namedParameters: object): DaemonSet[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: DaemonSet[]

    Default value __namedParameters: object= {}

    @@ -2063,7 +2063,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2093,7 +2093,7 @@

    remove#

    remove(item: DaemonSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2114,7 +2114,7 @@

    Protected removeItem#

    removeItem(item: DaemonSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: DaemonSet

    request: function

    @@ -2125,19 +2125,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2158,13 +2158,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: DaemonSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2185,7 +2185,7 @@

    Protected sortItems#

    sortItems(items: DaemonSet[], sorting?: function[], order?: "asc" | "desc"): DaemonSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2219,7 +2219,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2242,7 +2242,7 @@

    toggleSelection#

    toggleSelection(item: DaemonSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2263,7 +2263,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: DaemonSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2286,7 +2286,7 @@

    unselect#

    unselect(item: DaemonSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2307,7 +2307,7 @@

    update#

    update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2332,13 +2332,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: DaemonSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: DaemonSet

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html index f7ce9b995a..6535bc303a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -1265,7 +1265,7 @@

    constructor#

    + new Deployment(data: KubeJsonApiData): Deployment

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1286,22 +1286,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:75

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:75

    Type declaration:#

    @@ -1463,19 +1463,19 @@

    getAffinity#

    getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity


    getAffinityNumber#

    getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1508,7 +1508,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1530,7 +1530,7 @@

    getConditions#

    getConditions(activeOnly: boolean): object[]

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:171

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:171

    Parameters:

    @@ -1552,7 +1552,7 @@

    getConditionsText#

    getConditionsText(activeOnly: boolean): string

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:183

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:183

    Parameters:

    @@ -1575,96 +1575,96 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeSelectors#

    getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getReplicas#

    getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:187

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:187

    Returns: number


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSelectors#

    getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]


    getTemplateLabels#

    getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTolerations#

    getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1687,7 +1687,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1708,7 +1708,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1729,7 +1729,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1750,7 +1750,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1771,7 +1771,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html index 7d95e5006c..98bbe092ed 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -1222,7 +1222,7 @@

    constructor#

    + new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1243,86 +1243,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Deployment

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Deployment

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    Inherited from KubeApi.watchDisposer

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1352,7 +1352,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1381,7 +1381,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1410,7 +1410,7 @@

    getReplicas#

    getReplicas(params: object): Promise‹number›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    Parameters:

    params: object

    @@ -1436,7 +1436,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1458,7 +1458,7 @@

    Protected getScaleApiUrl#

    getScaleApiUrl(params: object): string

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    Parameters:

    params: object

    @@ -1484,7 +1484,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1514,7 +1514,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1542,7 +1542,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1567,7 +1567,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    Inherited from KubeApi.modifyWatchEvent

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1588,7 +1588,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1611,7 +1611,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1636,7 +1636,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1657,7 +1657,7 @@

    restart#

    restart(params: object): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    Parameters:

    params: object

    @@ -1682,7 +1682,7 @@

    scale#

    scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    Parameters:

    params: object

    @@ -1709,7 +1709,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1737,7 +1737,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1767,7 +1767,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html index b1003c6768..f2a1110eee 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -1412,97 +1412,97 @@

    constructor#

    + new DeploymentStore(): DeploymentStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: DeploymentStore

    Properties#

    api#

    api: DeploymentApi‹› = deploymentApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Deployment[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Deployment[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Deployment[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Deployment[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1525,7 +1525,7 @@

    create#

    create(params: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1553,7 +1553,7 @@

    createItem(params: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1580,7 +1580,7 @@

    Protected defaultSorting#

    defaultSorting(item: Deployment): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1601,7 +1601,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Deployment[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1622,7 +1622,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Deployment[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1650,7 +1650,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1671,7 +1671,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Deployment[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1693,7 +1693,7 @@

    getByName(name: string, namespace?: string): Deployment

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByPath#

    getByPath(path: string): Deployment

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1738,7 +1738,7 @@

    getChildPods#

    getChildPods(deployment: Deployment): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    Parameters:

    @@ -1759,7 +1759,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1780,13 +1780,13 @@

    getItems#

    getItems(): Deployment[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Deployment[]


    getStatuses#

    getStatuses(deployments?: Deployment[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    Parameters:

    @@ -1818,20 +1818,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Deployment): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1852,7 +1852,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Deployment[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1875,7 +1875,7 @@

    load#

    load(params: object): Promise‹Deployment

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1902,7 +1902,7 @@

    loadAll(options: object): Promise‹void | Deployment[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1928,7 +1928,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1950,7 +1950,7 @@

    loadItem(params: object): Promise‹Deployment

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1977,7 +1977,7 @@

    loadItems(__namedParameters: object): Promise‹Deployment[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2002,7 +2002,7 @@

    loadMetrics#

    loadMetrics(deployment: Deployment): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    Parameters:

    @@ -2023,7 +2023,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Deployment[], __namedParameters: object): Deployment[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Deployment[]

    Default value __namedParameters: object= {}

    @@ -2063,7 +2063,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2093,7 +2093,7 @@

    remove#

    remove(item: Deployment): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2114,7 +2114,7 @@

    Protected removeItem#

    removeItem(item: Deployment, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Deployment

    request: function

    @@ -2125,19 +2125,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2158,13 +2158,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Deployment): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2185,7 +2185,7 @@

    Protected sortItems#

    sortItems(items: Deployment[]): Deployment‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    Parameters:

    @@ -2207,7 +2207,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2230,7 +2230,7 @@

    toggleSelection#

    toggleSelection(item: Deployment): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2251,7 +2251,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Deployment[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2274,7 +2274,7 @@

    unselect#

    unselect(item: Deployment): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2295,7 +2295,7 @@

    update#

    update(item: Deployment, data: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2320,13 +2320,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Deployment, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Deployment

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html index 0f676de548..0439bc3cf4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -1209,7 +1209,7 @@

    constructor#

    + new Endpoint(data: KubeJsonApiData): Endpoint

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1230,51 +1230,51 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    Optional status#

    status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:102

    +

    Defined in src/renderer/api/kube-object.ts:102


    subsets#

    subsets: IEndpointSubset[]

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109


    Static apiBase#

    apiBase: string = "/api/v1/endpoints"

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107


    Static kind#

    kind: string = "Endpoints"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105


    Static namespaced#

    namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    Accessors#

    get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:104

    +

    Defined in src/renderer/api/kube-object.ts:104

    Returns: string

    Methods#

    delete#

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:193

    +

    Defined in src/renderer/api/kube-object.ts:193

    Parameters:

    @@ -1295,7 +1295,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1328,7 +1328,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1350,78 +1350,78 @@

    getEndpointSubsets#

    getEndpointSubsets(): EndpointSubset[]

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    Returns: EndpointSubset[]


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    toString#

    toString(): string

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    Returns: string


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1444,7 +1444,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1465,7 +1465,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1486,7 +1486,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1507,7 +1507,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1528,7 +1528,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html index b625b69a1b..260eb006bf 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new EndpointStore(): EndpointStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: EndpointStore

    Properties#

    api#

    api: KubeApiEndpoint‹›› = endpointApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

    +

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Endpoint[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Endpoint[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Endpoint[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Endpoint[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: Endpoint): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Endpoint[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Endpoint[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Endpoint[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): Endpoint

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): Endpoint

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): Endpoint[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Endpoint[]


    Optional getStatuses#

    getStatuses(items: Endpoint[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Endpoint): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Endpoint[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹Endpoint

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | Endpoint[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹Endpoint

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹Endpoint[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Endpoint[], __namedParameters: object): Endpoint[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Endpoint[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: Endpoint): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: Endpoint, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Endpoint

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Endpoint): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: Endpoint[], sorting?: function[], order?: "asc" | "desc"): Endpoint[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: Endpoint): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Endpoint[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: Endpoint): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: Endpoint, data: Partial‹Endpoint›): Promise‹Endpoint

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Endpoint, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Endpoint

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html index eecb064300..ee8cd10ca2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -1420,103 +1420,103 @@

    constructor#

    + new EventStore(): EventStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: EventStore

    Properties#

    api#

    api: KubeApiKubeEvent‹›› = eventApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+events/event.store.ts:13

    +

    Defined in src/renderer/components/+events/event.store.ts:13


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    limit#

    limit: number = 1000

    Overrides KubeObjectStore.limit

    -

    Defined in src/renderer/components/+events/event.store.ts:14

    +

    Defined in src/renderer/components/+events/event.store.ts:14


    saveLimit#

    saveLimit: number = 50000

    -

    Defined in src/renderer/components/+events/event.store.ts:15

    +

    Defined in src/renderer/components/+events/event.store.ts:15


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): KubeEvent[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: KubeEvent[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): KubeEvent[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: KubeEvent[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(): void

    Overrides KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/components/+events/event.store.ts:17

    +

    Defined in src/renderer/components/+events/event.store.ts:17

    Returns: void


    create#

    create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1544,7 +1544,7 @@

    createItem(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1571,7 +1571,7 @@

    Protected defaultSorting#

    defaultSorting(item: KubeEvent): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1592,7 +1592,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: KubeEvent[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1613,7 +1613,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): KubeEvent[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1641,7 +1641,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1662,7 +1662,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): KubeEvent[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1684,7 +1684,7 @@

    getByName(name: string, namespace?: string): KubeEvent

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1709,7 +1709,7 @@

    getByPath#

    getByPath(path: string): KubeEvent

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1729,7 +1729,7 @@

    getEventsByObject#

    getEventsByObject(obj: KubeObject): KubeEvent[]

    -

    Defined in src/renderer/components/+events/event.store.ts:27

    +

    Defined in src/renderer/components/+events/event.store.ts:27

    Parameters:

    @@ -1750,7 +1750,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1771,13 +1771,13 @@

    getItems#

    getItems(): KubeEvent[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: KubeEvent[]


    Optional getStatuses#

    getStatuses(items: KubeEvent[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1798,30 +1798,30 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    getWarnings#

    getWarnings(): KubeEvent‹›[]

    -

    Defined in src/renderer/components/+events/event.store.ts:37

    +

    Defined in src/renderer/components/+events/event.store.ts:37

    Returns: KubeEvent‹›[]


    getWarningsCount#

    getWarningsCount(): number

    -

    Defined in src/renderer/components/+events/event.store.ts:56

    +

    Defined in src/renderer/components/+events/event.store.ts:56

    Returns: number


    isSelected#

    isSelected(item: KubeEvent): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1842,7 +1842,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: KubeEvent[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1865,7 +1865,7 @@

    load#

    load(params: object): Promise‹KubeEvent

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1892,7 +1892,7 @@

    loadAll(options: object): Promise‹void | KubeEvent[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1918,7 +1918,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1940,7 +1940,7 @@

    loadItem(params: object): Promise‹KubeEvent

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1967,7 +1967,7 @@

    loadItems(__namedParameters: object): Promise‹KubeEvent[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1993,7 +1993,7 @@

    Protected mergeItems#

    mergeItems(partialItems: KubeEvent[], __namedParameters: object): KubeEvent[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: KubeEvent[]

    Default value __namedParameters: object= {}

    @@ -2033,7 +2033,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2063,7 +2063,7 @@

    remove#

    remove(item: KubeEvent): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2084,7 +2084,7 @@

    Protected removeItem#

    removeItem(item: KubeEvent, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: KubeEvent

    request: function

    @@ -2095,19 +2095,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2128,13 +2128,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: KubeEvent): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2155,7 +2155,7 @@

    Protected sortItems#

    sortItems(items: KubeEvent[]): KubeEvent‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+events/event.store.ts:21

    +

    Defined in src/renderer/components/+events/event.store.ts:21

    Parameters:

    @@ -2177,7 +2177,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2200,7 +2200,7 @@

    toggleSelection#

    toggleSelection(item: KubeEvent): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2221,7 +2221,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: KubeEvent[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2244,7 +2244,7 @@

    unselect#

    unselect(item: KubeEvent): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2265,7 +2265,7 @@

    update#

    update(item: KubeEvent, data: Partial‹KubeEvent›): Promise‹KubeEvent

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2290,13 +2290,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: KubeEvent, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: KubeEvent

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html index be9bee6cbf..86b185cc0c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -1257,7 +1257,7 @@

    constructor#

    + new HorizontalPodAutoscaler(data: KubeJsonApiData): HorizontalPodAutoscaler

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1278,21 +1278,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    Type declaration:#

    @@ -1382,7 +1382,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1415,7 +1415,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1437,40 +1437,40 @@

    getConditions#

    getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    Returns: object[]


    getCurrentMetrics#

    getCurrentMetrics(): IHpaMetric[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    Returns: IHpaMetric[]


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getMaxPods#

    getMaxPods(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    Returns: number


    Protected getMetricName#

    getMetricName(metric: IHpaMetric): string

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    Parameters:

    @@ -1490,7 +1490,7 @@

    getMetricValues#

    getMetricValues(metric: IHpaMetric): string

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    Parameters:

    @@ -1510,65 +1510,65 @@

    getMetrics#

    getMetrics(): IHpaMetric[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    Returns: IHpaMetric[]


    getMinPods#

    getMinPods(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    Returns: number


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getReplicas#

    getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    Returns: number


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1591,7 +1591,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1612,7 +1612,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1633,7 +1633,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1654,7 +1654,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1675,7 +1675,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html index fdc3f2c644..503819bf0f 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new HPAStore(): HPAStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: HPAStore

    Properties#

    api#

    api: KubeApiHorizontalPodAutoscaler‹›› = hpaApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

    +

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: HorizontalPodAutoscaler[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: HorizontalPodAutoscaler[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: HorizontalPodAutoscaler): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: HorizontalPodAutoscaler[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): HorizontalPodAutoscaler

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): HorizontalPodAutoscaler

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: HorizontalPodAutoscaler[]


    Optional getStatuses#

    getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: HorizontalPodAutoscaler): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹HorizontalPodAutoscaler

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | HorizontalPodAutoscaler[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹HorizontalPodAutoscaler

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹HorizontalPodAutoscaler[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: HorizontalPodAutoscaler[], __namedParameters: object): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: HorizontalPodAutoscaler[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: HorizontalPodAutoscaler): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: HorizontalPodAutoscaler, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: HorizontalPodAutoscaler

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: HorizontalPodAutoscaler[], sorting?: function[], order?: "asc" | "desc"): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: HorizontalPodAutoscaler, data: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: HorizontalPodAutoscaler

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html index 53ee8d7a7f..22fff2704a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -1233,7 +1233,7 @@

    constructor#

    + new Ingress(data: KubeJsonApiData): Ingress

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1254,21 +1254,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    Type declaration:#

    @@ -1343,7 +1343,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1376,7 +1376,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1399,74 +1399,74 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getHosts#

    getHosts(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getLoadBalancers#

    getLoadBalancers(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getPorts#

    getPorts(): string

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    Returns: string


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getRoutes#

    getRoutes(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    Returns: string[]


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getServiceNamePort#

    getServiceNamePort(): object

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    Returns: object

    @@ -1536,7 +1536,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1557,7 +1557,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1578,7 +1578,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1599,7 +1599,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html index 949252585c..cd1d017021 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -1198,7 +1198,7 @@

    constructor#

    + new IngressApi(options: IKubeApiOptions‹Ingress›): IngressApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1219,86 +1219,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Ingress

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Ingress

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    Inherited from KubeApi.watchDisposer

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1328,7 +1328,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1357,7 +1357,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1386,7 +1386,7 @@

    getMetrics#

    getMetrics(ingress: string, namespace: string): Promise‹IIngressMetrics›

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    Parameters:

    @@ -1411,7 +1411,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1434,7 +1434,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1464,7 +1464,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1492,7 +1492,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1517,7 +1517,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    Inherited from KubeApi.modifyWatchEvent

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1538,7 +1538,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1561,7 +1561,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1586,7 +1586,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1608,7 +1608,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1636,7 +1636,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1666,7 +1666,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html index cdb6838297..ce8747e81a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -1404,97 +1404,97 @@

    constructor#

    + new IngressStore(): IngressStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: IngressStore

    Properties#

    api#

    api: IngressApi‹› = ingressApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IIngressMetrics = null

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Ingress[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Ingress[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Ingress[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Ingress[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1517,7 +1517,7 @@

    create#

    create(params: object, data?: Partial‹Ingress›): Promise‹Ingress

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1545,7 +1545,7 @@

    createItem(params: object, data?: Partial‹Ingress›): Promise‹Ingress

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1572,7 +1572,7 @@

    Protected defaultSorting#

    defaultSorting(item: Ingress): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1593,7 +1593,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Ingress[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1614,7 +1614,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Ingress[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1642,7 +1642,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1663,7 +1663,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Ingress[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1685,7 +1685,7 @@

    getByName(name: string, namespace?: string): Ingress

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1710,7 +1710,7 @@

    getByPath#

    getByPath(path: string): Ingress

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1731,7 +1731,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1752,13 +1752,13 @@

    getItems#

    getItems(): Ingress[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Ingress[]


    Optional getStatuses#

    getStatuses(items: Ingress[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1779,20 +1779,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Ingress): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1813,7 +1813,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Ingress[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1836,7 +1836,7 @@

    load#

    load(params: object): Promise‹Ingress

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1863,7 +1863,7 @@

    loadAll(options: object): Promise‹void | Ingress[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1889,7 +1889,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1911,7 +1911,7 @@

    loadItem(params: object): Promise‹Ingress

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1938,7 +1938,7 @@

    loadItems(__namedParameters: object): Promise‹Ingress[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1963,7 +1963,7 @@

    loadMetrics#

    loadMetrics(ingress: Ingress): Promise‹void›

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    Parameters:

    @@ -1984,7 +1984,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Ingress[], __namedParameters: object): Ingress[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Ingress[]

    Default value __namedParameters: object= {}

    @@ -2024,7 +2024,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2054,7 +2054,7 @@

    remove#

    remove(item: Ingress): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2075,7 +2075,7 @@

    Protected removeItem#

    removeItem(item: Ingress, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Ingress

    request: function

    @@ -2086,19 +2086,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2119,13 +2119,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Ingress): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2146,7 +2146,7 @@

    Protected sortItems#

    sortItems(items: Ingress[], sorting?: function[], order?: "asc" | "desc"): Ingress[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2180,7 +2180,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2203,7 +2203,7 @@

    toggleSelection#

    toggleSelection(item: Ingress): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2224,7 +2224,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Ingress[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2247,7 +2247,7 @@

    unselect#

    unselect(item: Ingress): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2268,7 +2268,7 @@

    update#

    update(item: Ingress, data: Partial‹Ingress›): Promise‹Ingress

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2293,13 +2293,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Ingress, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Ingress

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html index 89295155a7..dd0719e445 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -1281,7 +1281,7 @@

    constructor#

    + new Job(data: KubeJsonApiData): Job

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1302,22 +1302,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/job.api.ts:14

    +

    Defined in src/renderer/api/endpoints/job.api.ts:14

    Type declaration:#

    @@ -1501,7 +1501,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1523,12 +1523,12 @@

    getCompletions#

    getCompletions(): number

    -

    Defined in src/renderer/api/endpoints/job.api.ts:77

    +

    Defined in src/renderer/api/endpoints/job.api.ts:77

    Returns: number


    getCondition#

    getCondition(): object

    -

    Defined in src/renderer/api/endpoints/job.api.ts:85

    +

    Defined in src/renderer/api/endpoints/job.api.ts:85

    Returns: object

    @@ -1694,7 +1694,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1715,7 +1715,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1736,7 +1736,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1757,7 +1757,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html index 801ebb2a31..2b5962b33c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -1404,93 +1404,93 @@

    constructor#

    + new JobStore(): JobStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: JobStore

    Properties#

    api#

    api: KubeApiJob‹›› = jobApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Job[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Job[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Job[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Job[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1513,7 +1513,7 @@

    create#

    create(params: object, data?: Partial‹Job›): Promise‹Job

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1541,7 +1541,7 @@

    createItem(params: object, data?: Partial‹Job›): Promise‹Job

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1568,7 +1568,7 @@

    Protected defaultSorting#

    defaultSorting(item: Job): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1589,7 +1589,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Job[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1610,7 +1610,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Job[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1638,7 +1638,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1659,7 +1659,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Job[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1681,7 +1681,7 @@

    getByName(name: string, namespace?: string): Job

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1706,7 +1706,7 @@

    getByPath#

    getByPath(path: string): Job

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1726,7 +1726,7 @@

    getChildPods#

    getChildPods(job: Job): Pod[]

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    Parameters:

    @@ -1747,7 +1747,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1768,12 +1768,12 @@

    getItems#

    getItems(): Job[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Job[]


    getJobsByOwner#

    getJobsByOwner(cronJob: CronJob): Job‹›[]

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    Parameters:

    @@ -1794,7 +1794,7 @@

    getStatuses#

    getStatuses(jobs?: Job[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    Parameters:

    @@ -1829,20 +1829,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Job): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1863,7 +1863,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Job[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1886,7 +1886,7 @@

    load#

    load(params: object): Promise‹Job

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1913,7 +1913,7 @@

    loadAll(options: object): Promise‹void | Job[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1939,7 +1939,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1961,7 +1961,7 @@

    loadItem(params: object): Promise‹Job

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1988,7 +1988,7 @@

    loadItems(__namedParameters: object): Promise‹Job[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2014,7 +2014,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Job[], __namedParameters: object): Job[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Job[]

    Default value __namedParameters: object= {}

    @@ -2054,7 +2054,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2084,7 +2084,7 @@

    remove#

    remove(item: Job): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2105,7 +2105,7 @@

    Protected removeItem#

    removeItem(item: Job, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Job

    request: function

    @@ -2116,19 +2116,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2149,13 +2149,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Job): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2176,7 +2176,7 @@

    Protected sortItems#

    sortItems(items: Job[], sorting?: function[], order?: "asc" | "desc"): Job[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2210,7 +2210,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2233,7 +2233,7 @@

    toggleSelection#

    toggleSelection(item: Job): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2254,7 +2254,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Job[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2277,7 +2277,7 @@

    unselect#

    unselect(item: Job): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2298,7 +2298,7 @@

    update#

    update(item: Job, data: Partial‹Job›): Promise‹Job

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2323,13 +2323,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Job, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Job

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html index a173e939ae..b39b578cea 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -1202,7 +1202,7 @@

    Constructors#

    constructor#

    + new KubeApi(options: IKubeApiOptions‹T›): KubeApi

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1222,71 +1222,71 @@

    Properties#

    apiBase#

    apiBase: string

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹T›

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹T›

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1315,7 +1315,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1343,7 +1343,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1372,7 +1372,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1394,7 +1394,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1423,7 +1423,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1450,7 +1450,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1474,7 +1474,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1494,7 +1494,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1516,7 +1516,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1540,7 +1540,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1561,7 +1561,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1588,7 +1588,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1617,7 +1617,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html index 0ca1b65d23..6101ec567c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -1305,7 +1305,7 @@

    constructor#

    + new KubeEvent(data: KubeJsonApiData): KubeEvent

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1326,23 +1326,23 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    count#

    count: number

    -

    Defined in src/renderer/api/endpoints/events.api.ts:30

    +

    Defined in src/renderer/api/endpoints/events.api.ts:30


    eventTime#

    eventTime: null

    -

    Defined in src/renderer/api/endpoints/events.api.ts:32

    +

    Defined in src/renderer/api/endpoints/events.api.ts:32


    firstTimestamp#

    firstTimestamp: string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:28

    +

    Defined in src/renderer/api/endpoints/events.api.ts:28


    involvedObject#

    involvedObject: object

    -

    Defined in src/renderer/api/endpoints/events.api.ts:13

    +

    Defined in src/renderer/api/endpoints/events.api.ts:13

    Type declaration:#

    @@ -1464,7 +1464,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1497,7 +1497,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1520,87 +1520,87 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getFirstSeenTime#

    getFirstSeenTime(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:46

    +

    Defined in src/renderer/api/endpoints/events.api.ts:46

    Returns: string


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getLastSeenTime#

    getLastSeenTime(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:52

    +

    Defined in src/renderer/api/endpoints/events.api.ts:52

    Returns: string


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSource#

    getSource(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:40

    +

    Defined in src/renderer/api/endpoints/events.api.ts:40

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    isWarning#

    isWarning(): boolean

    -

    Defined in src/renderer/api/endpoints/events.api.ts:36

    +

    Defined in src/renderer/api/endpoints/events.api.ts:36

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1623,7 +1623,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1644,7 +1644,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1665,7 +1665,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1686,7 +1686,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1707,7 +1707,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html index 668199b153..df5a317df5 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -1196,7 +1196,7 @@

    Constructors#

    constructor#

    + new KubeObject(data: KubeJsonApiData): KubeObject

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1216,36 +1216,36 @@

    Properties#

    apiVersion#

    apiVersion: string

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    Optional status#

    status? : any

    -

    Defined in src/renderer/api/kube-object.ts:102

    +

    Defined in src/renderer/api/kube-object.ts:102


    Static kind#

    kind: string

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70


    Static namespaced#

    namespaced: boolean

    -

    Defined in src/renderer/api/kube-object.ts:71

    +

    Defined in src/renderer/api/kube-object.ts:71

    Accessors#

    get selfLink(): string

    -

    Defined in src/renderer/api/kube-object.ts:104

    +

    Defined in src/renderer/api/kube-object.ts:104

    Returns: string

    Methods#

    delete#

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/kube-object.ts:193

    +

    Defined in src/renderer/api/kube-object.ts:193

    Parameters:

    @@ -1265,7 +1265,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1297,7 +1297,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1319,57 +1319,57 @@

    getFinalizers#

    getFinalizers(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1391,7 +1391,7 @@

    Static create#

    create(data: any): KubeObject‹›

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1411,7 +1411,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1431,7 +1431,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1451,7 +1451,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1471,7 +1471,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html index d5cba19c8f..9393787a7b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -1426,83 +1426,83 @@

    Constructors#

    constructor#

    + new KubeObjectStore(): KubeObjectStore

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: KubeObjectStore

    Properties#

    Abstract api#

    api: KubeApi‹T›

    -

    Defined in src/renderer/kube-object.store.ts:21

    +

    Defined in src/renderer/kube-object.store.ts:21


    bufferSize#

    bufferSize: number = 50000

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): T[]

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: T[]


    query#

    get query(): IKubeApiQueryParams

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): T[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: T[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1524,7 +1524,7 @@

    create#

    create(params: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1551,7 +1551,7 @@

    Protected createItem#

    createItem(params: object, data?: Partial‹T›): Promise‹T›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1578,7 +1578,7 @@

    Protected defaultSorting#

    defaultSorting(item: T): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1598,7 +1598,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: T[]): T[]

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1618,7 +1618,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): T[]

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1645,7 +1645,7 @@

    getById#

    getById(id: string): T

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): T[]

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1686,7 +1686,7 @@

    getByName#

    getByName(name: string, namespace?: string): T

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1710,7 +1710,7 @@

    getByPath#

    getByPath(path: string): T

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1731,7 +1731,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1752,12 +1752,12 @@

    getItems#

    getItems(): T[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: T[]


    Optional getStatuses#

    getStatuses(items: T[]): Record‹string, number›

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1777,19 +1777,19 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: T): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1810,7 +1810,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: T[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1832,7 +1832,7 @@

    load#

    load(params: object): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1858,7 +1858,7 @@

    loadAll#

    loadAll(options: object): Promise‹void | T[]›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1883,7 +1883,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1904,7 +1904,7 @@

    Protected loadItem#

    loadItem(params: object): Promise‹T›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1930,7 +1930,7 @@

    Protected loadItems#

    loadItems(__namedParameters: object): Promise‹T[]›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1955,7 +1955,7 @@

    Protected mergeItems#

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: T[]

    Default value __namedParameters: object= {}

    @@ -1994,7 +1994,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2023,7 +2023,7 @@

    remove#

    remove(item: T): Promise‹void›

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2044,7 +2044,7 @@

    Protected removeItem#

    removeItem(item: T, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: T

    request: function

    @@ -2054,18 +2054,18 @@

    removeSelectedItems#

    removeSelectedItems(): Promise‹void[]›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2086,13 +2086,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: T): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2113,7 +2113,7 @@

    Protected sortItems#

    sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2146,7 +2146,7 @@

    subscribe#

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2169,7 +2169,7 @@

    toggleSelection#

    toggleSelection(item: T): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2190,7 +2190,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: T[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2213,7 +2213,7 @@

    unselect#

    unselect(item: T): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2233,7 +2233,7 @@

    update#

    update(item: T, data: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2257,13 +2257,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: T, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: T

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html index fb320e08c0..168fbc74a2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html @@ -1217,7 +1217,7 @@

    constructor#

    + new LimitRange(data: KubeJsonApiData): LimitRange

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1238,21 +1238,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/limit-range.api.ts:38

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:38

    Type declaration:#

    @@ -1307,7 +1307,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1340,7 +1340,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1362,83 +1362,83 @@

    getContainerLimits#

    getContainerLimits(): LimitRangeItem‹›[]

    -

    Defined in src/renderer/api/endpoints/limit-range.api.ts:42

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:42

    Returns: LimitRangeItem‹›[]


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getPVCLimits#

    getPVCLimits(): LimitRangeItem‹›[]

    -

    Defined in src/renderer/api/endpoints/limit-range.api.ts:50

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:50

    Returns: LimitRangeItem‹›[]


    getPodLimits#

    getPodLimits(): LimitRangeItem‹›[]

    -

    Defined in src/renderer/api/endpoints/limit-range.api.ts:46

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:46

    Returns: LimitRangeItem‹›[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1461,7 +1461,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1482,7 +1482,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1503,7 +1503,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1524,7 +1524,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1545,7 +1545,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html index 2fddf3c3d5..4c59aa3870 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new LimitRangesStore(): LimitRangesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: LimitRangesStore

    Properties#

    api#

    api: KubeApiLimitRange‹›› = limitRangeApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:8

    +

    Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): LimitRange[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: LimitRange[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): LimitRange[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: LimitRange[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: LimitRange): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: LimitRange[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): LimitRange[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): LimitRange[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): LimitRange

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): LimitRange

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): LimitRange[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: LimitRange[]


    Optional getStatuses#

    getStatuses(items: LimitRange[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: LimitRange): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: LimitRange[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹LimitRange

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | LimitRange[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹LimitRange

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹LimitRange[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: LimitRange[], __namedParameters: object): LimitRange[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: LimitRange[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: LimitRange): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: LimitRange, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: LimitRange

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: LimitRange): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: LimitRange[], sorting?: function[], order?: "asc" | "desc"): LimitRange[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: LimitRange): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: LimitRange[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: LimitRange): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: LimitRange, data: Partial‹LimitRange›): Promise‹LimitRange

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: LimitRange, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: LimitRange

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html index 5616deff4a..fa36f9baa2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -1193,7 +1193,7 @@

    constructor#

    + new Namespace(data: KubeJsonApiData): Namespace

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1214,22 +1214,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    Optional status#

    status? : object

    Overrides KubeObject.status

    -

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    Type declaration:#

    @@ -1279,7 +1279,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1312,7 +1312,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1335,72 +1335,72 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getStatus#

    getStatus(): string

    -

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1423,7 +1423,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1444,7 +1444,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1465,7 +1465,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1486,7 +1486,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1507,7 +1507,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html index 595cf0c176..757d0f08cc 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -1460,108 +1460,108 @@

    constructor#

    + new NamespaceStore(): NamespaceStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:34

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:34

    Returns: NamespaceStore

    Properties#

    api#

    api: KubeApiNamespace‹›› = namespacesApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:32

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:32


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    allowedNamespaces#

    get allowedNamespaces(): string[]

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:92

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:92

    Returns: string[]


    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Namespace[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Namespace[]


    contextNamespaces#

    get contextNamespaces(): string[]

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:99

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:99

    Returns: string[]


    hasAllContexts#

    get hasAllContexts(): boolean

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:148

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:148

    Returns: boolean


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Namespace[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Namespace[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1584,7 +1584,7 @@

    create#

    create(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1612,7 +1612,7 @@

    createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1639,7 +1639,7 @@

    Protected defaultSorting#

    defaultSorting(item: Namespace): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1660,7 +1660,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Namespace[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1681,7 +1681,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Namespace[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1709,7 +1709,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1730,7 +1730,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Namespace[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1752,7 +1752,7 @@

    getByName(name: string, namespace?: string): Namespace

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1777,7 +1777,7 @@

    getByPath#

    getByPath(path: string): Namespace

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1798,7 +1798,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1819,13 +1819,13 @@

    getItems#

    getItems(): Namespace[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Namespace[]


    Optional getStatuses#

    getStatuses(items: Namespace[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1846,19 +1846,19 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi‹any›[]

    Overrides KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:109

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:109

    Returns: KubeApi‹any›[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    hasContext#

    hasContext(namespaces: string | string[]): boolean

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:144

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:144

    Parameters:

    @@ -1879,7 +1879,7 @@

    isSelected#

    isSelected(item: Namespace): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1900,7 +1900,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Namespace[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1923,7 +1923,7 @@

    load#

    load(params: object): Promise‹Namespace

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1950,7 +1950,7 @@

    loadAll(options: object): Promise‹void | Namespace[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1976,7 +1976,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1998,7 +1998,7 @@

    loadItem(params: object): Promise‹Namespace

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -2024,7 +2024,7 @@

    Protected loadItems#

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:118

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:118

    Parameters:

    @@ -2045,7 +2045,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Namespace[], __namedParameters: object): Namespace[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Namespace[]

    Default value __namedParameters: object= {}

    @@ -2084,7 +2084,7 @@

    onContextChange#

    onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:50

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:50

    Parameters:

    callback: function

    ▸ (contextNamespaces: string[]): void

    @@ -2109,7 +2109,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2139,7 +2139,7 @@

    remove#

    remove(item: Namespace): Promise‹void›

    Overrides KubeObjectStore.remove

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:175

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:175

    Parameters:

    @@ -2160,7 +2160,7 @@

    Protected removeItem#

    removeItem(item: Namespace, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Namespace

    request: function

    @@ -2171,24 +2171,24 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    resetContext#

    resetContext(): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:140

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:140

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2209,13 +2209,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Namespace): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2235,7 +2235,7 @@

    setContext#

    setContext(namespace: string | string[]): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:133

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:133

    Parameters:

    @@ -2256,7 +2256,7 @@

    Protected sortItems#

    sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2290,7 +2290,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2312,7 +2312,7 @@

    toggleAll#

    toggleAll(showAll?: boolean): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:162

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:162

    Parameters:

    @@ -2332,7 +2332,7 @@

    toggleContext#

    toggleContext(namespace: string): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:153

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:153

    Parameters:

    @@ -2353,7 +2353,7 @@

    toggleSelection#

    toggleSelection(item: Namespace): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2374,7 +2374,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Namespace[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2397,7 +2397,7 @@

    unselect#

    unselect(item: Namespace): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2418,7 +2418,7 @@

    update#

    update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2443,13 +2443,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Namespace, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Namespace

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html index 7fd336e67a..f4127de495 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -1209,7 +1209,7 @@

    constructor#

    + new NetworkPolicy(data: KubeJsonApiData): NetworkPolicy

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1230,21 +1230,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    Type declaration:#

    @@ -1316,7 +1316,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1349,7 +1349,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1372,77 +1372,77 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getMatchLabels#

    getMatchLabels(): string[]

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTypes#

    getTypes(): string[]

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    Returns: string[]


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1465,7 +1465,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1486,7 +1486,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1507,7 +1507,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1528,7 +1528,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1549,7 +1549,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html index f2145832e0..e533b4641e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new NetworkPolicyStore(): NetworkPolicyStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: NetworkPolicyStore

    Properties#

    api#

    api: KubeApiNetworkPolicy‹›› = networkPolicyApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

    +

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): NetworkPolicy[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: NetworkPolicy[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): NetworkPolicy[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: NetworkPolicy[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: NetworkPolicy): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: NetworkPolicy[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): NetworkPolicy[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): NetworkPolicy[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): NetworkPolicy

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): NetworkPolicy

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): NetworkPolicy[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: NetworkPolicy[]


    Optional getStatuses#

    getStatuses(items: NetworkPolicy[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: NetworkPolicy): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: NetworkPolicy[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | NetworkPolicy[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹NetworkPolicy[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: NetworkPolicy[], __namedParameters: object): NetworkPolicy[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: NetworkPolicy[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: NetworkPolicy): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: NetworkPolicy, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: NetworkPolicy

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: NetworkPolicy): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: NetworkPolicy[], sorting?: function[], order?: "asc" | "desc"): NetworkPolicy[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: NetworkPolicy): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: NetworkPolicy[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: NetworkPolicy): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: NetworkPolicy, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: NetworkPolicy

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html index 69c7fa961f..63bdf967c4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -1281,7 +1281,7 @@

    constructor#

    + new Node(data: KubeJsonApiData): Node

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1302,21 +1302,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    Type declaration:#

    @@ -1450,13 +1450,13 @@

    getActiveConditions#

    getActiveConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    Returns: object[]


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1489,7 +1489,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1511,118 +1511,118 @@

    getConditions#

    getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    Returns: object[]


    getCpuCapacity#

    getCpuCapacity(): number

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    Returns: number


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getKubeletVersion#

    getKubeletVersion(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getMemoryCapacity#

    getMemoryCapacity(): number

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    Returns: number


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeConditionText#

    getNodeConditionText(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOperatingSystem#

    getOperatingSystem(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getRoleLabels#

    getRoleLabels(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTaints#

    getTaints(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    Returns: object[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getWarningConditions#

    getWarningConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    Returns: object[]


    isUnschedulable#

    isUnschedulable(): boolean

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1645,7 +1645,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1666,7 +1666,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1687,7 +1687,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1708,7 +1708,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1729,7 +1729,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html index ac43f92e44..2fe9725943 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -1198,7 +1198,7 @@

    constructor#

    + new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1219,86 +1219,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Node

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Node

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    Inherited from KubeApi.watchDisposer

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1328,7 +1328,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1357,7 +1357,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1386,13 +1386,13 @@

    getMetrics#

    getMetrics(): Promise‹INodeMetrics›

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    Returns: Promise‹INodeMetrics›


    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1415,7 +1415,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1445,7 +1445,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1473,7 +1473,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1498,7 +1498,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    Inherited from KubeApi.modifyWatchEvent

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1519,7 +1519,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1542,7 +1542,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1567,7 +1567,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1589,7 +1589,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1617,7 +1617,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1647,7 +1647,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html index eb293fbf9f..95f3b3aa5d 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -1468,119 +1468,119 @@

    constructor#

    + new NodesStore(): NodesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: NodesStore

    Properties#

    api#

    api: NodesApi‹› = nodesApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:10

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: Partial‹INodeMetrics›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:12


    metricsLoaded#

    metricsLoaded: boolean = false

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:15

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:15


    metricsLoading#

    metricsLoading: boolean = false

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:14


    nodeMetrics#

    nodeMetrics: Partial‹IClusterMetrics› = null

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:13


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Node[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Node[]


    masterNodes#

    get masterNodes(): Node‹›[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:34

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:34

    Returns: Node‹›[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Node[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Node[]


    workerNodes#

    get workerNodes(): Node‹›[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:38

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:38

    Returns: Node‹›[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1603,7 +1603,7 @@

    create#

    create(params: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1631,7 +1631,7 @@

    createItem(params: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1658,7 +1658,7 @@

    Protected defaultSorting#

    defaultSorting(item: Node): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1679,7 +1679,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Node[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1700,7 +1700,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Node[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1728,7 +1728,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1749,7 +1749,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Node[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1771,7 +1771,7 @@

    getByName(name: string, namespace?: string): Node

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1796,7 +1796,7 @@

    getByPath#

    getByPath(path: string): Node

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1817,7 +1817,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1838,12 +1838,12 @@

    getItems#

    getItems(): Node[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Node[]


    getLastMetricValues#

    getLastMetricValues(node: Node, metricNames: string[]): number[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:42

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:42

    Parameters:

    @@ -1868,7 +1868,7 @@

    Optional getStatuses#

    getStatuses(items: Node[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1889,25 +1889,25 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    getWarningsCount#

    getWarningsCount(): number

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:66

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:66

    Returns: number


    isSelected#

    isSelected(item: Node): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1928,7 +1928,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Node[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1951,7 +1951,7 @@

    load#

    load(params: object): Promise‹Node

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1978,7 +1978,7 @@

    loadAll(options: object): Promise‹void | Node[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -2004,7 +2004,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -2026,7 +2026,7 @@

    loadItem(params: object): Promise‹Node

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -2053,7 +2053,7 @@

    loadItems(__namedParameters: object): Promise‹Node[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2078,7 +2078,7 @@

    loadMetrics#

    loadMetrics(nodeName: string): Promise‹void›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:30

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:30

    Parameters:

    @@ -2098,13 +2098,13 @@

    loadUsageMetrics#

    loadUsageMetrics(): Promise‹void›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:18

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:18

    Returns: Promise‹void›


    Protected mergeItems#

    mergeItems(partialItems: Node[], __namedParameters: object): Node[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Node[]

    Default value __namedParameters: object= {}

    @@ -2144,7 +2144,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2174,7 +2174,7 @@

    remove#

    remove(item: Node): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2195,7 +2195,7 @@

    Protected removeItem#

    removeItem(item: Node, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Node

    request: function

    @@ -2206,19 +2206,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:70

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:70

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2239,13 +2239,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Node): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2266,7 +2266,7 @@

    Protected sortItems#

    sortItems(items: Node[], sorting?: function[], order?: "asc" | "desc"): Node[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2300,7 +2300,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2323,7 +2323,7 @@

    toggleSelection#

    toggleSelection(item: Node): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2344,7 +2344,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Node[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2367,7 +2367,7 @@

    unselect#

    unselect(item: Node): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2388,7 +2388,7 @@

    update#

    update(item: Node, data: Partial‹Node›): Promise‹Node

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2413,13 +2413,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Node, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Node

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html index 827534d882..e2caa73857 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -1233,7 +1233,7 @@

    constructor#

    + new PersistentVolume(data: KubeJsonApiData): PersistentVolume

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1254,21 +1254,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    Type declaration:#

    @@ -1402,7 +1402,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1435,7 +1435,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1457,7 +1457,7 @@

    getCapacity#

    getCapacity(inBytes: boolean): string | number

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    Parameters:

    @@ -1479,88 +1479,88 @@

    getClaimRefName#

    getClaimRefName(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:70

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:70

    Returns: string


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getStatus#

    getStatus(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    Returns: string


    getStorageClass#

    getStorageClass(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    Returns: string


    getStorageClassName#

    getStorageClassName(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:74

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:74

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1583,7 +1583,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1604,7 +1604,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1625,7 +1625,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1646,7 +1646,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1667,7 +1667,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html index ec30481ba6..1d2f79de03 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -1233,7 +1233,7 @@

    constructor#

    + new PersistentVolumeClaim(data: KubeJsonApiData): PersistentVolumeClaim

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1254,21 +1254,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    Type declaration:#

    @@ -1353,7 +1353,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1386,7 +1386,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1409,52 +1409,52 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getMatchExpressions#

    getMatchExpressions(): object[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    Returns: object[]


    getMatchLabels#

    getMatchLabels(): string[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getPods#

    getPods(allPods: Pod[]): Pod[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    Parameters:

    @@ -1475,41 +1475,41 @@

    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getStatus#

    getStatus(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    Returns: string


    getStorage#

    getStorage(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    Returns: string


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1532,7 +1532,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1553,7 +1553,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1574,7 +1574,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1595,7 +1595,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1616,7 +1616,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html index 211033d7e7..83ce0fdea2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -1198,7 +1198,7 @@

    constructor#

    + new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1219,86 +1219,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹PersistentVolumeClaim

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    Inherited from KubeApi.watchDisposer

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1328,7 +1328,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1357,7 +1357,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1386,7 +1386,7 @@

    getMetrics#

    getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    Parameters:

    @@ -1411,7 +1411,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1434,7 +1434,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1464,7 +1464,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1492,7 +1492,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1517,7 +1517,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    Inherited from KubeApi.modifyWatchEvent

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1538,7 +1538,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1561,7 +1561,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1586,7 +1586,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1608,7 +1608,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1636,7 +1636,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1666,7 +1666,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html index 9236015e1e..951df3c458 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -1396,93 +1396,93 @@

    constructor#

    + new PersistentVolumesStore(): PersistentVolumesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: PersistentVolumesStore

    Properties#

    api#

    api: KubeApiPersistentVolume‹›› = persistentVolumeApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:9

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:9


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): PersistentVolume[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: PersistentVolume[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): PersistentVolume[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PersistentVolume[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1505,7 +1505,7 @@

    create#

    create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1533,7 +1533,7 @@

    createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1560,7 +1560,7 @@

    Protected defaultSorting#

    defaultSorting(item: PersistentVolume): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1581,7 +1581,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: PersistentVolume[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1602,7 +1602,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1630,7 +1630,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1651,7 +1651,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): PersistentVolume[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1673,7 +1673,7 @@

    getByName(name: string, namespace?: string): PersistentVolume

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1698,7 +1698,7 @@

    getByPath#

    getByPath(path: string): PersistentVolume

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByStorageClass#

    getByStorageClass(storageClass: StorageClass): PersistentVolume[]

    -

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:11

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:11

    Parameters:

    @@ -1739,7 +1739,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1760,13 +1760,13 @@

    getItems#

    getItems(): PersistentVolume[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: PersistentVolume[]


    Optional getStatuses#

    getStatuses(items: PersistentVolume[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1787,20 +1787,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: PersistentVolume): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1821,7 +1821,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: PersistentVolume[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1844,7 +1844,7 @@

    load#

    load(params: object): Promise‹PersistentVolume

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1871,7 +1871,7 @@

    loadAll(options: object): Promise‹void | PersistentVolume[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1897,7 +1897,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1919,7 +1919,7 @@

    loadItem(params: object): Promise‹PersistentVolume

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1946,7 +1946,7 @@

    loadItems(__namedParameters: object): Promise‹PersistentVolume[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1972,7 +1972,7 @@

    Protected mergeItems#

    mergeItems(partialItems: PersistentVolume[], __namedParameters: object): PersistentVolume[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: PersistentVolume[]

    Default value __namedParameters: object= {}

    @@ -2012,7 +2012,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2042,7 +2042,7 @@

    remove#

    remove(item: PersistentVolume): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2063,7 +2063,7 @@

    Protected removeItem#

    removeItem(item: PersistentVolume, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: PersistentVolume

    request: function

    @@ -2074,19 +2074,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2107,13 +2107,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: PersistentVolume): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2134,7 +2134,7 @@

    Protected sortItems#

    sortItems(items: PersistentVolume[], sorting?: function[], order?: "asc" | "desc"): PersistentVolume[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2168,7 +2168,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2191,7 +2191,7 @@

    toggleSelection#

    toggleSelection(item: PersistentVolume): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2212,7 +2212,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: PersistentVolume[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2235,7 +2235,7 @@

    unselect#

    unselect(item: PersistentVolume): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2256,7 +2256,7 @@

    update#

    update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2281,13 +2281,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: PersistentVolume, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: PersistentVolume

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html index 8f925124de..f1928941df 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -1417,7 +1417,7 @@

    constructor#

    + new Pod(data: KubeJsonApiData): Pod

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1438,22 +1438,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:190

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:190

    Type declaration:#

    @@ -1621,19 +1621,19 @@

    getAffinity#

    getAffinity(): IAffinity

    Overrides Deployment.getAffinity

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:407

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:390

    Returns: IAffinity


    getAffinityNumber#

    getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1665,13 +1665,13 @@

    getAllContainers#

    getAllContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:272

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:272

    Returns: IPodContainer[]


    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1693,12 +1693,12 @@

    getConditions#

    getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:381

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:366

    Returns: object[]


    getContainerStatuses#

    getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:285

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:287

    Parameters:

    @@ -1720,35 +1720,35 @@

    getContainers#

    getContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:268

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:268

    Returns: IPodContainer[]


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getInitContainers#

    getInitContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:264

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:264

    Returns: IPodContainer[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getLivenessProbe#

    getLivenessProbe(container: IPodContainer): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:428

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:410

    Parameters:

    @@ -1769,40 +1769,40 @@

    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeName#

    getNodeName(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:478

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:460

    Returns: string


    getNodeSelectors#

    getNodeSelectors(): string[]

    Overrides Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:395

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:380

    Returns: string[]


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getPriorityClassName#

    getPriorityClassName(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:316

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:311

    Returns: string


    getProbe#

    getProbe(probeData: IContainerProbe): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:440

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:422

    Parameters:

    @@ -1822,12 +1822,12 @@

    getQosClass#

    getQosClass(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:308

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:303

    Returns: string


    getReadinessProbe#

    getReadinessProbe(container: IPodContainer): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:432

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:414

    Parameters:

    @@ -1847,50 +1847,50 @@

    getReason#

    getReason(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:312

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:307

    Returns: string


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getRestartsCount#

    getRestartsCount(): number

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:300

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:297

    Returns: number


    getRunningContainers#

    getRunningContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:276

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:276

    Returns: IPodContainer[]


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSecrets#

    getSecrets(): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:389

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:374

    Returns: string[]


    getSelectedNodeOs#

    -

    getSelectedNodeOs(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:482

    -

    Returns: string

    +

    getSelectedNodeOs(): string | undefined

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:464

    +

    Returns: string | undefined


    getSelectors#

    getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]


    getStartupProbe#

    getStartupProbe(container: IPodContainer): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:436

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:418

    Parameters:

    @@ -1909,58 +1909,58 @@

    Returns: string[]


    getStatus#

    -

    getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:321

    -

    Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    +

    getStatus(): PodStatus

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:315

    +

    Returns: PodStatus


    getStatusMessage#

    getStatusMessage(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:348

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:343

    Returns: string


    getStatusPhase#

    getStatusPhase(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:377

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:362

    Returns: string


    getTemplateLabels#

    getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTolerations#

    getTolerations(): object[]

    Overrides Deployment.getTolerations

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:403

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:386

    Returns: object[]


    getVolumes#

    getVolumes(): object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:385

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:370

    Returns: object[]


    hasIssues#

    hasIssues(): boolean

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:411

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:394

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1983,7 +1983,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -2004,7 +2004,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -2025,7 +2025,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -2046,7 +2046,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -2067,7 +2067,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html index c158230c97..d59fc2c792 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -1233,7 +1233,7 @@

    constructor#

    + new PodDisruptionBudget(data: KubeJsonApiData): PodDisruptionBudget

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1254,21 +1254,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    Type declaration:#

    @@ -1349,7 +1349,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1382,7 +1382,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1404,93 +1404,93 @@

    getCurrentHealthy#

    getCurrentHealthy(): number

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    Returns: number


    getDesiredHealthy#

    getDesiredHealthy(): number

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    Returns: number


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getMaxUnavailable#

    getMaxUnavailable(): string

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    Returns: string


    getMinAvailable#

    getMinAvailable(): string

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    Returns: string


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSelectors#

    getSelectors(): string[]

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1513,7 +1513,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1534,7 +1534,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1555,7 +1555,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1576,7 +1576,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1597,7 +1597,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html index ed97a3d7bb..b9788c301a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: PodDisruptionBudgetsStore

    Properties#

    api#

    api: KubeApiPodDisruptionBudget‹›› = pdbApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

    +

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): PodDisruptionBudget[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: PodDisruptionBudget[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): PodDisruptionBudget[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PodDisruptionBudget[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: PodDisruptionBudget): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): PodDisruptionBudget[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): PodDisruptionBudget

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): PodDisruptionBudget

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): PodDisruptionBudget[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: PodDisruptionBudget[]


    Optional getStatuses#

    getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: PodDisruptionBudget): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹PodDisruptionBudget

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | PodDisruptionBudget[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹PodDisruptionBudget

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹PodDisruptionBudget[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: PodDisruptionBudget[], __namedParameters: object): PodDisruptionBudget[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: PodDisruptionBudget[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: PodDisruptionBudget): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: PodDisruptionBudget

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: PodDisruptionBudget[], sorting?: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: PodDisruptionBudget

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html index 72c7f41942..a415f73fea 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -1206,7 +1206,7 @@

    constructor#

    + new PodsApi(options: IKubeApiOptions‹Pod›): PodsApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1227,86 +1227,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:111

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Pod

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Pod

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:119

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:115

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:116


    Protected watchDisposer#

    watchDisposer: function

    Inherited from KubeApi.watchDisposer

    -

    Defined in src/renderer/api/kube-api.ts:117

    +

    Defined in src/renderer/api/kube-api.ts:117

    Type declaration:#

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:147

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:209

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:330

    +

    Defined in src/renderer/api/kube-api.ts:330

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1336,7 +1336,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:357

    +

    Defined in src/renderer/api/kube-api.ts:357

    Parameters:

    __namedParameters: object

    @@ -1365,7 +1365,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1394,7 +1394,7 @@

    getLogs#

    getLogs(params: object, query?: IPodLogsQuery): Promise‹string›

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    Parameters:

    params: object

    @@ -1420,7 +1420,7 @@

    getMetrics#

    getMetrics(pods: Pod[], namespace: string, selector: string): Promise‹IPodMetrics›

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    Parameters:

    @@ -1453,7 +1453,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:242

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1476,7 +1476,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:250

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1506,7 +1506,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:364

    +

    Defined in src/renderer/api/kube-api.ts:364

    Parameters:

    @@ -1534,7 +1534,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:314

    +

    Defined in src/renderer/api/kube-api.ts:314

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1559,7 +1559,7 @@

    Protected modifyWatchEvent#

    modifyWatchEvent(event: IKubeWatchEvent): void

    Inherited from KubeApi.modifyWatchEvent

    -

    Defined in src/renderer/api/kube-api.ts:447

    +

    Defined in src/renderer/api/kube-api.ts:447

    Parameters:

    @@ -1580,7 +1580,7 @@

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:262

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1603,7 +1603,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:274

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1628,7 +1628,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:246

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1650,7 +1650,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:238

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1678,7 +1678,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:348

    +

    Defined in src/renderer/api/kube-api.ts:348

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1708,7 +1708,7 @@

    watch#

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:372

    +

    Defined in src/renderer/api/kube-api.ts:372

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html index 7904938a8a..5ee6443e75 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -1460,101 +1460,101 @@

    constructor#

    + new PodsStore(): PodsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: PodsStore

    Properties#

    api#

    api: PodsApi‹› = podsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    kubeMetrics#

    kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Pod[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Pod[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Pod[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Pod[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1577,7 +1577,7 @@

    create#

    create(params: object, data?: Partial‹Pod›): Promise‹Pod

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1605,7 +1605,7 @@

    createItem(params: object, data?: Partial‹Pod›): Promise‹Pod

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1632,7 +1632,7 @@

    Protected defaultSorting#

    defaultSorting(item: Pod): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1653,7 +1653,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Pod[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1674,7 +1674,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Pod[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1702,7 +1702,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1723,7 +1723,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Pod[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1745,7 +1745,7 @@

    getByName(name: string, namespace?: string): Pod

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1770,7 +1770,7 @@

    getByPath#

    getByPath(path: string): Pod

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1791,7 +1791,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1812,12 +1812,12 @@

    getItems#

    getItems(): Pod[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Pod[]


    getPodKubeMetrics#

    getPodKubeMetrics(pod: Pod): object

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:63

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:63

    Parameters:

    @@ -1845,7 +1845,7 @@

    getPodsByNode#

    getPodsByNode(node: string): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    Parameters:

    @@ -1865,7 +1865,7 @@

    getPodsByOwner#

    getPodsByOwner(workload: WorkloadKubeObject): Pod[]

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

    Parameters:

    @@ -1885,7 +1885,7 @@

    getPodsByOwnerId#

    getPodsByOwnerId(workloadId: string): Pod[]

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

    Parameters:

    @@ -1906,7 +1906,7 @@

    getStatuses#

    getStatuses(pods: Pod[]): Dictionary‹number›

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:59

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:59

    Parameters:

    @@ -1927,20 +1927,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Pod): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1961,7 +1961,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Pod[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1984,7 +1984,7 @@

    load#

    load(params: object): Promise‹Pod

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -2011,7 +2011,7 @@

    loadAll(options: object): Promise‹void | Pod[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -2036,7 +2036,7 @@

    loadContainerMetrics#

    loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    Parameters:

    @@ -2057,7 +2057,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -2079,7 +2079,7 @@

    loadItem(params: object): Promise‹Pod

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -2106,7 +2106,7 @@

    loadItems(__namedParameters: object): Promise‹Pod[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2131,7 +2131,7 @@

    loadKubeMetrics#

    loadKubeMetrics(namespace?: string): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    Parameters:

    @@ -2151,7 +2151,7 @@

    loadMetrics#

    loadMetrics(pod: Pod): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    Parameters:

    @@ -2172,7 +2172,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Pod[], __namedParameters: object): Pod[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Pod[]

    Default value __namedParameters: object= {}

    @@ -2212,7 +2212,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2242,7 +2242,7 @@

    remove#

    remove(item: Pod): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2263,7 +2263,7 @@

    Protected removeItem#

    removeItem(item: Pod, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Pod

    request: function

    @@ -2274,19 +2274,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:92

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:92

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2307,13 +2307,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Pod): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2334,7 +2334,7 @@

    Protected sortItems#

    sortItems(items: Pod[], sorting?: function[], order?: "asc" | "desc"): Pod[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2368,7 +2368,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2391,7 +2391,7 @@

    toggleSelection#

    toggleSelection(item: Pod): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2412,7 +2412,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Pod[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2435,7 +2435,7 @@

    unselect#

    unselect(item: Pod): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2456,7 +2456,7 @@

    update#

    update(item: Pod, data: Partial‹Pod›): Promise‹Pod

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2481,13 +2481,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Pod, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Pod

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html index 39fcb00eee..808caf631b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -1273,7 +1273,7 @@

    constructor#

    + new ReplicaSet(data: KubeJsonApiData): ReplicaSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1294,22 +1294,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:35

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:35

    Type declaration:#

    @@ -1413,19 +1413,19 @@

    getAffinity#

    getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity


    getAffinityNumber#

    getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1458,7 +1458,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1480,112 +1480,112 @@

    getCurrent#

    getCurrent(): number

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:68

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:68

    Returns: number


    getDesired#

    getDesired(): number

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:64

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:64

    Returns: number


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getImages#

    getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:76

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:76

    Returns: string[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeSelectors#

    getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getReady#

    getReady(): number

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:72

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:72

    Returns: number


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSelectors#

    getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]


    getTemplateLabels#

    getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTolerations#

    getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1608,7 +1608,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1629,7 +1629,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1650,7 +1650,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1671,7 +1671,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1692,7 +1692,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html index bd98ca8885..df0017c9ea 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -1420,97 +1420,97 @@

    constructor#

    + new ReplicaSetStore(): ReplicaSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: ReplicaSetStore

    Properties#

    api#

    api: ReplicaSetApi‹› = replicaSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): ReplicaSet[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: ReplicaSet[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): ReplicaSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ReplicaSet[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1533,7 +1533,7 @@

    create#

    create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1561,7 +1561,7 @@

    createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1588,7 +1588,7 @@

    Protected defaultSorting#

    defaultSorting(item: ReplicaSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1609,7 +1609,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: ReplicaSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1630,7 +1630,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1658,7 +1658,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1679,7 +1679,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): ReplicaSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1701,7 +1701,7 @@

    getByName(name: string, namespace?: string): ReplicaSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1726,7 +1726,7 @@

    getByPath#

    getByPath(path: string): ReplicaSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1746,7 +1746,7 @@

    getChildPods#

    getChildPods(replicaSet: ReplicaSet): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

    Parameters:

    @@ -1767,7 +1767,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1788,12 +1788,12 @@

    getItems#

    getItems(): ReplicaSet[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: ReplicaSet[]


    getReplicaSetsByOwner#

    getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

    Parameters:

    @@ -1814,7 +1814,7 @@

    getStatuses#

    getStatuses(replicaSets: ReplicaSet[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

    Parameters:

    @@ -1846,20 +1846,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: ReplicaSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1880,7 +1880,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: ReplicaSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1903,7 +1903,7 @@

    load#

    load(params: object): Promise‹ReplicaSet

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1930,7 +1930,7 @@

    loadAll(options: object): Promise‹void | ReplicaSet[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1956,7 +1956,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1978,7 +1978,7 @@

    loadItem(params: object): Promise‹ReplicaSet

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -2005,7 +2005,7 @@

    loadItems(__namedParameters: object): Promise‹ReplicaSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2030,7 +2030,7 @@

    loadMetrics#

    loadMetrics(replicaSet: ReplicaSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

    Parameters:

    @@ -2051,7 +2051,7 @@

    Protected mergeItems#

    mergeItems(partialItems: ReplicaSet[], __namedParameters: object): ReplicaSet[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: ReplicaSet[]

    Default value __namedParameters: object= {}

    @@ -2091,7 +2091,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2121,7 +2121,7 @@

    remove#

    remove(item: ReplicaSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2142,7 +2142,7 @@

    Protected removeItem#

    removeItem(item: ReplicaSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: ReplicaSet

    request: function

    @@ -2153,19 +2153,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2186,13 +2186,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: ReplicaSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2213,7 +2213,7 @@

    Protected sortItems#

    sortItems(items: ReplicaSet[], sorting?: function[], order?: "asc" | "desc"): ReplicaSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2247,7 +2247,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2270,7 +2270,7 @@

    toggleSelection#

    toggleSelection(item: ReplicaSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2291,7 +2291,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: ReplicaSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2314,7 +2314,7 @@

    unselect#

    unselect(item: ReplicaSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2335,7 +2335,7 @@

    update#

    update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2360,13 +2360,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: ReplicaSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: ReplicaSet

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html index bb530b78c4..f0b4a343d8 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -1201,7 +1201,7 @@

    constructor#

    + new ResourceQuota(data: KubeJsonApiData): ResourceQuota

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    Parameters:

    @@ -1222,21 +1222,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    Type declaration:#

    @@ -1308,7 +1308,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1341,7 +1341,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1364,72 +1364,72 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getScopeSelector#

    getScopeSelector(): object[]

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    Returns: object[]


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1452,7 +1452,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1473,7 +1473,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1494,7 +1494,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1515,7 +1515,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1536,7 +1536,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html index fa5b275e03..e437499ad1 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new ResourceQuotasStore(): ResourceQuotasStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: ResourceQuotasStore

    Properties#

    api#

    api: KubeApiResourceQuota‹›› = resourceQuotaApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

    +

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): ResourceQuota[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: ResourceQuota[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): ResourceQuota[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ResourceQuota[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: ResourceQuota): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: ResourceQuota[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): ResourceQuota[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): ResourceQuota

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): ResourceQuota

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): ResourceQuota[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: ResourceQuota[]


    Optional getStatuses#

    getStatuses(items: ResourceQuota[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: ResourceQuota): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: ResourceQuota[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹ResourceQuota

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | ResourceQuota[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹ResourceQuota

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹ResourceQuota[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: ResourceQuota[], __namedParameters: object): ResourceQuota[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: ResourceQuota[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: ResourceQuota): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: ResourceQuota, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: ResourceQuota

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: ResourceQuota): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: ResourceQuota[], sorting?: function[], order?: "asc" | "desc"): ResourceQuota[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: ResourceQuota): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: ResourceQuota[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: ResourceQuota): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: ResourceQuota, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: ResourceQuota

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html index e2a1c4e238..bfb2126ed3 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -1202,7 +1202,7 @@

    constructor#

    + new Role(data: KubeJsonApiData): Role

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1223,51 +1223,51 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    rules#

    rules: object[]

    -

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9


    Optional status#

    status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:102

    +

    Defined in src/renderer/api/kube-object.ts:102


    Static apiBase#

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

    -

    Defined in src/renderer/api/endpoints/role.api.ts:7

    +

    Defined in src/renderer/api/endpoints/role.api.ts:7


    Static kind#

    kind: string = "Role"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/role.api.ts:5

    +

    Defined in src/renderer/api/endpoints/role.api.ts:5


    Static namespaced#

    namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/role.api.ts:6

    +

    Defined in src/renderer/api/endpoints/role.api.ts:6

    Accessors#

    get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:104

    +

    Defined in src/renderer/api/kube-object.ts:104

    Returns: string

    Methods#

    delete#

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:193

    +

    Defined in src/renderer/api/kube-object.ts:193

    Parameters:

    @@ -1288,7 +1288,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1321,7 +1321,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1344,72 +1344,72 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getRules#

    getRules(): object[]

    -

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    Returns: object[]


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1432,7 +1432,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1453,7 +1453,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1474,7 +1474,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1495,7 +1495,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1516,7 +1516,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html index 15a4ef0afa..62d863458b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -1218,7 +1218,7 @@

    constructor#

    + new RoleBinding(data: KubeJsonApiData): RoleBinding

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1239,21 +1239,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    roleRef#

    roleRef: object

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    Type declaration:#

    @@ -1320,7 +1320,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1353,7 +1353,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1376,77 +1376,77 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSubjectNames#

    getSubjectNames(): string

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    Returns: string


    getSubjects#

    getSubjects(): IRoleBindingSubject[]

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    Returns: IRoleBindingSubject[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1469,7 +1469,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1490,7 +1490,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1511,7 +1511,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1532,7 +1532,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1553,7 +1553,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html index 20d371e02c..043d32faa1 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -1396,93 +1396,93 @@

    constructor#

    + new RoleBindingsStore(): RoleBindingsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: RoleBindingsStore

    Properties#

    api#

    api: KubeApiClusterRoleBinding‹›› = clusterRoleBindingApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): RoleBinding[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: RoleBinding[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): RoleBinding[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: RoleBinding[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1505,7 +1505,7 @@

    create#

    create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1532,7 +1532,7 @@

    Protected createItem#

    createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:38

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:38

    Parameters:

    params: object

    @@ -1559,7 +1559,7 @@

    Protected defaultSorting#

    defaultSorting(item: RoleBinding): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1580,7 +1580,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: RoleBinding[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1601,7 +1601,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1629,7 +1629,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1650,7 +1650,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): RoleBinding[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1672,7 +1672,7 @@

    getByName(name: string, namespace?: string): RoleBinding

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1697,7 +1697,7 @@

    getByPath#

    getByPath(path: string): RoleBinding

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1718,7 +1718,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1739,13 +1739,13 @@

    getItems#

    getItems(): RoleBinding[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: RoleBinding[]


    Optional getStatuses#

    getStatuses(items: RoleBinding[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1766,20 +1766,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApiRoleBinding‹››[]

    Overrides KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    Returns: KubeApiRoleBinding‹››[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: RoleBinding): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1800,7 +1800,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: RoleBinding[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1823,7 +1823,7 @@

    load#

    load(params: object): Promise‹RoleBinding

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1850,7 +1850,7 @@

    loadAll(options: object): Promise‹void | RoleBinding[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1876,7 +1876,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1897,7 +1897,7 @@

    Protected loadItem#

    loadItem(params: object): Promise‹RoleBinding‹››

    Overrides KubeObjectStore.loadItem

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    Parameters:

    params: object

    @@ -1923,7 +1923,7 @@

    Protected loadItems#

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹RoleBinding[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    Parameters:

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: RoleBinding[], __namedParameters: object): RoleBinding[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: RoleBinding[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: RoleBinding): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: RoleBinding, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: RoleBinding

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: RoleBinding): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: RoleBinding[]): RoleBinding‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    Parameters:

    @@ -2128,7 +2128,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2151,7 +2151,7 @@

    toggleSelection#

    toggleSelection(item: RoleBinding): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2172,7 +2172,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: RoleBinding[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2195,7 +2195,7 @@

    unselect#

    unselect(item: RoleBinding): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2216,7 +2216,7 @@

    update#

    update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2241,13 +2241,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: RoleBinding, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: RoleBinding

    request: function

    @@ -2256,7 +2256,7 @@

    updateSubjects#

    updateSubjects(params: object): Promise‹RoleBinding‹››

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:46

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:46

    Parameters:

    params: object

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html index 3567509fc3..5d81a4bae6 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new RolesStore(): RolesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: RolesStore

    Properties#

    api#

    api: KubeApiClusterRole‹›› = clusterRoleApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Role[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Role[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Role[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Role[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹Role›): Promise‹Role

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1524,7 +1524,7 @@

    Protected createItem#

    createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:36

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:36

    Parameters:

    params: object

    @@ -1551,7 +1551,7 @@

    Protected defaultSorting#

    defaultSorting(item: Role): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1572,7 +1572,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Role[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1593,7 +1593,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Role[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1621,7 +1621,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1642,7 +1642,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Role[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1664,7 +1664,7 @@

    getByName(name: string, namespace?: string): Role

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1689,7 +1689,7 @@

    getByPath#

    getByPath(path: string): Role

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1710,7 +1710,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1731,13 +1731,13 @@

    getItems#

    getItems(): Role[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Role[]


    Optional getStatuses#

    getStatuses(items: Role[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1758,20 +1758,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApiRole‹››[]

    Overrides KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    Returns: KubeApiRole‹››[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Role): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1792,7 +1792,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Role[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1815,7 +1815,7 @@

    load#

    load(params: object): Promise‹Role

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1842,7 +1842,7 @@

    loadAll(options: object): Promise‹void | Role[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1868,7 +1868,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1889,7 +1889,7 @@

    Protected loadItem#

    loadItem(params: object): Promise‹Role‹››

    Overrides KubeObjectStore.loadItem

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    Parameters:

    params: object

    @@ -1915,7 +1915,7 @@

    Protected loadItems#

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Role[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    Parameters:

    @@ -1936,7 +1936,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Role[], __namedParameters: object): Role[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Role[]

    Default value __namedParameters: object= {}

    @@ -1976,7 +1976,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2006,7 +2006,7 @@

    remove#

    remove(item: Role): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2027,7 +2027,7 @@

    Protected removeItem#

    removeItem(item: Role, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Role

    request: function

    @@ -2038,19 +2038,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2071,13 +2071,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Role): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2098,7 +2098,7 @@

    Protected sortItems#

    sortItems(items: Role[]): Role‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    Parameters:

    @@ -2120,7 +2120,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2143,7 +2143,7 @@

    toggleSelection#

    toggleSelection(item: Role): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2164,7 +2164,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Role[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2187,7 +2187,7 @@

    unselect#

    unselect(item: Role): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2208,7 +2208,7 @@

    update#

    update(item: Role, data: Partial‹Role›): Promise‹Role

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2233,13 +2233,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Role, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Role

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html index 1358a5676a..2d46fd1beb 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -1217,7 +1217,7 @@

    constructor#

    + new Secret(data: KubeJsonApiData): Secret

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    Parameters:

    @@ -1238,11 +1238,11 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    data#

    data: object

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    Type declaration:#

    @@ -1316,7 +1316,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1349,7 +1349,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1372,77 +1372,77 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getKeys#

    getKeys(): string[]

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    Returns: string[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getToken#

    getToken(): string

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    Returns: string


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1465,7 +1465,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1486,7 +1486,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1507,7 +1507,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1528,7 +1528,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1549,7 +1549,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html index 9fddcb56f5..77eb91ff14 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new SecretsStore(): SecretsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: SecretsStore

    Properties#

    api#

    api: KubeApiSecret‹›› = secretsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

    +

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Secret[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Secret[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Secret[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Secret[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹Secret›): Promise‹Secret

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹Secret›): Promise‹Secret

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: Secret): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Secret[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Secret[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Secret[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): Secret

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): Secret

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): Secret[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Secret[]


    Optional getStatuses#

    getStatuses(items: Secret[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Secret): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Secret[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹Secret

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | Secret[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹Secret

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹Secret[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Secret[], __namedParameters: object): Secret[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Secret[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: Secret): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: Secret, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Secret

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Secret): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: Secret[], sorting?: function[], order?: "asc" | "desc"): Secret[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: Secret): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Secret[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: Secret): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: Secret, data: Partial‹Secret›): Promise‹Secret

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Secret, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Secret

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html index 4378f4a053..98f8d9e196 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -1257,7 +1257,7 @@

    constructor#

    + new Service(data: KubeJsonApiData): Service

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1278,21 +1278,21 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    -

    Defined in src/renderer/api/endpoints/service.api.ts:38

    +

    Defined in src/renderer/api/endpoints/service.api.ts:38

    Type declaration:#

    @@ -1379,7 +1379,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1412,7 +1412,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1434,35 +1434,35 @@

    getClusterIp#

    getClusterIp(): string

    -

    Defined in src/renderer/api/endpoints/service.api.ts:58

    +

    Defined in src/renderer/api/endpoints/service.api.ts:58

    Returns: string


    getExternalIps#

    getExternalIps(): string[]

    -

    Defined in src/renderer/api/endpoints/service.api.ts:62

    +

    Defined in src/renderer/api/endpoints/service.api.ts:62

    Returns: string[]


    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getLoadBalancer#

    getLoadBalancer(): object

    -

    Defined in src/renderer/api/endpoints/service.api.ts:88

    +

    Defined in src/renderer/api/endpoints/service.api.ts:88

    Returns: object

    @@ -1582,7 +1582,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1603,7 +1603,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1624,7 +1624,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1645,7 +1645,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html index 78baa47ab8..351e5b3aa4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -1217,7 +1217,7 @@

    constructor#

    + new ServiceAccount(data: KubeJsonApiData): ServiceAccount

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1238,55 +1238,55 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    Optional imagePullSecrets#

    imagePullSecrets? : object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    Optional secrets#

    secrets? : object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11


    Optional status#

    status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:102

    +

    Defined in src/renderer/api/kube-object.ts:102


    Static apiBase#

    apiBase: string = "/api/v1/serviceaccounts"

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9


    Static kind#

    kind: string = "ServiceAccount"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7


    Static namespaced#

    namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    Accessors#

    get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:104

    +

    Defined in src/renderer/api/kube-object.ts:104

    Returns: string

    Methods#

    delete#

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:193

    +

    Defined in src/renderer/api/kube-object.ts:193

    Parameters:

    @@ -1307,7 +1307,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1340,7 +1340,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1363,77 +1363,77 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getImagePullSecrets#

    getImagePullSecrets(): object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    Returns: object[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSecrets#

    getSecrets(): object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    Returns: object[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1456,7 +1456,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1477,7 +1477,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1498,7 +1498,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1519,7 +1519,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1540,7 +1540,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html index 8da2de81e1..bed897ed82 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new ServiceAccountsStore(): ServiceAccountsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: ServiceAccountsStore

    Properties#

    api#

    api: KubeApiServiceAccount‹›› = serviceAccountsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): ServiceAccount[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: ServiceAccount[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): ServiceAccount[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ServiceAccount[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1524,7 +1524,7 @@

    Protected createItem#

    createItem(params: object): Promise‹ServiceAccount‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    Parameters:

    params: object

    @@ -1550,7 +1550,7 @@

    Protected defaultSorting#

    defaultSorting(item: ServiceAccount): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1571,7 +1571,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: ServiceAccount[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1592,7 +1592,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1620,7 +1620,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1641,7 +1641,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): ServiceAccount[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1663,7 +1663,7 @@

    getByName(name: string, namespace?: string): ServiceAccount

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1688,7 +1688,7 @@

    getByPath#

    getByPath(path: string): ServiceAccount

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1709,7 +1709,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1730,13 +1730,13 @@

    getItems#

    getItems(): ServiceAccount[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: ServiceAccount[]


    Optional getStatuses#

    getStatuses(items: ServiceAccount[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1757,20 +1757,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: ServiceAccount): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1791,7 +1791,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: ServiceAccount[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1814,7 +1814,7 @@

    load#

    load(params: object): Promise‹ServiceAccount

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1841,7 +1841,7 @@

    loadAll(options: object): Promise‹void | ServiceAccount[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1867,7 +1867,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1889,7 +1889,7 @@

    loadItem(params: object): Promise‹ServiceAccount

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1916,7 +1916,7 @@

    loadItems(__namedParameters: object): Promise‹ServiceAccount[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1942,7 +1942,7 @@

    Protected mergeItems#

    mergeItems(partialItems: ServiceAccount[], __namedParameters: object): ServiceAccount[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: ServiceAccount[]

    Default value __namedParameters: object= {}

    @@ -1982,7 +1982,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2012,7 +2012,7 @@

    remove#

    remove(item: ServiceAccount): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2033,7 +2033,7 @@

    Protected removeItem#

    removeItem(item: ServiceAccount, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: ServiceAccount

    request: function

    @@ -2044,19 +2044,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2077,13 +2077,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: ServiceAccount): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2104,7 +2104,7 @@

    Protected sortItems#

    sortItems(items: ServiceAccount[], sorting?: function[], order?: "asc" | "desc"): ServiceAccount[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2138,7 +2138,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2161,7 +2161,7 @@

    toggleSelection#

    toggleSelection(item: ServiceAccount): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2182,7 +2182,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: ServiceAccount[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2205,7 +2205,7 @@

    unselect#

    unselect(item: ServiceAccount): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2226,7 +2226,7 @@

    update#

    update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2251,13 +2251,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: ServiceAccount, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: ServiceAccount

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html index 2bfc8885a6..3524ca860a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -1388,93 +1388,93 @@

    constructor#

    + new ServiceStore(): ServiceStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: ServiceStore

    Properties#

    api#

    api: KubeApiService‹›› = serviceApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-services/services.store.ts:8

    +

    Defined in src/renderer/components/+network-services/services.store.ts:8


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): Service[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: Service[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): Service[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Service[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1497,7 +1497,7 @@

    create#

    create(params: object, data?: Partial‹Service›): Promise‹Service

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1525,7 +1525,7 @@

    createItem(params: object, data?: Partial‹Service›): Promise‹Service

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1552,7 +1552,7 @@

    Protected defaultSorting#

    defaultSorting(item: Service): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1573,7 +1573,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: Service[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1594,7 +1594,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): Service[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1622,7 +1622,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1643,7 +1643,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): Service[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1665,7 +1665,7 @@

    getByName(name: string, namespace?: string): Service

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1690,7 +1690,7 @@

    getByPath#

    getByPath(path: string): Service

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1711,7 +1711,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1732,13 +1732,13 @@

    getItems#

    getItems(): Service[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: Service[]


    Optional getStatuses#

    getStatuses(items: Service[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1759,20 +1759,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: Service): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1793,7 +1793,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: Service[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1816,7 +1816,7 @@

    load#

    load(params: object): Promise‹Service

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1843,7 +1843,7 @@

    loadAll(options: object): Promise‹void | Service[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1869,7 +1869,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1891,7 +1891,7 @@

    loadItem(params: object): Promise‹Service

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1918,7 +1918,7 @@

    loadItems(__namedParameters: object): Promise‹Service[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1944,7 +1944,7 @@

    Protected mergeItems#

    mergeItems(partialItems: Service[], __namedParameters: object): Service[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: Service[]

    Default value __namedParameters: object= {}

    @@ -1984,7 +1984,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2014,7 +2014,7 @@

    remove#

    remove(item: Service): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2035,7 +2035,7 @@

    Protected removeItem#

    removeItem(item: Service, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: Service

    request: function

    @@ -2046,19 +2046,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2079,13 +2079,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: Service): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2106,7 @@

    Protected sortItems#

    sortItems(items: Service[], sorting?: function[], order?: "asc" | "desc"): Service[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2140,7 +2140,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2163,7 +2163,7 @@

    toggleSelection#

    toggleSelection(item: Service): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2184,7 +2184,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: Service[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2207,7 +2207,7 @@

    unselect#

    unselect(item: Service): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2228,7 +2228,7 @@

    update#

    update(item: Service, data: Partial‹Service›): Promise‹Service

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2253,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: Service, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: Service

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html index 90776cc533..afeaa06ae0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -1257,7 +1257,7 @@

    constructor#

    + new StatefulSet(data: KubeJsonApiData): StatefulSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1278,22 +1278,22 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    Type declaration:#

    @@ -1417,19 +1417,19 @@

    getAffinity#

    getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity


    getAffinityNumber#

    getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number


    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1462,7 +1462,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1485,101 +1485,101 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getImages#

    getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    Returns: string[]


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNodeSelectors#

    getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getReplicas#

    getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    Returns: number


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getSelectors#

    getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]


    getTemplateLabels#

    getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getTolerations#

    getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1602,7 +1602,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1623,7 +1623,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1644,7 +1644,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1665,7 +1665,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1686,7 +1686,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html index 3e6a621c1c..a14ab83f11 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -1412,97 +1412,97 @@

    constructor#

    + new StatefulSetStore(): StatefulSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: StatefulSetStore

    Properties#

    api#

    api: StatefulSetApi‹› = statefulSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): StatefulSet[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: StatefulSet[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): StatefulSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: StatefulSet[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1525,7 +1525,7 @@

    create#

    create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1553,7 +1553,7 @@

    createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1580,7 +1580,7 @@

    Protected defaultSorting#

    defaultSorting(item: StatefulSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1601,7 +1601,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: StatefulSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1622,7 +1622,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1650,7 +1650,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1671,7 +1671,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): StatefulSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1693,7 +1693,7 @@

    getByName(name: string, namespace?: string): StatefulSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1718,7 +1718,7 @@

    getByPath#

    getByPath(path: string): StatefulSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1738,7 +1738,7 @@

    getChildPods#

    getChildPods(statefulSet: StatefulSet): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    Parameters:

    @@ -1759,7 +1759,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1780,13 +1780,13 @@

    getItems#

    getItems(): StatefulSet[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: StatefulSet[]


    getStatuses#

    getStatuses(statefulSets: StatefulSet[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    Parameters:

    @@ -1818,20 +1818,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: StatefulSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1852,7 +1852,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: StatefulSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1875,7 +1875,7 @@

    load#

    load(params: object): Promise‹StatefulSet

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1902,7 +1902,7 @@

    loadAll(options: object): Promise‹void | StatefulSet[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1928,7 +1928,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1950,7 +1950,7 @@

    loadItem(params: object): Promise‹StatefulSet

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1977,7 +1977,7 @@

    loadItems(__namedParameters: object): Promise‹StatefulSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -2002,7 +2002,7 @@

    loadMetrics#

    loadMetrics(statefulSet: StatefulSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    Parameters:

    @@ -2023,7 +2023,7 @@

    Protected mergeItems#

    mergeItems(partialItems: StatefulSet[], __namedParameters: object): StatefulSet[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: StatefulSet[]

    Default value __namedParameters: object= {}

    @@ -2063,7 +2063,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2093,7 +2093,7 @@

    remove#

    remove(item: StatefulSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2114,7 +2114,7 @@

    Protected removeItem#

    removeItem(item: StatefulSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: StatefulSet

    request: function

    @@ -2125,19 +2125,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2158,13 +2158,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: StatefulSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2185,7 +2185,7 @@

    Protected sortItems#

    sortItems(items: StatefulSet[], sorting?: function[], order?: "asc" | "desc"): StatefulSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2219,7 +2219,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2242,7 +2242,7 @@

    toggleSelection#

    toggleSelection(item: StatefulSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2263,7 +2263,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: StatefulSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2286,7 +2286,7 @@

    unselect#

    unselect(item: StatefulSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2307,7 +2307,7 @@

    update#

    update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2332,13 +2332,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: StatefulSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: StatefulSet

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html index 7bf2440d64..b3db8388b4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -1249,7 +1249,7 @@

    constructor#

    + new StorageClass(data: KubeJsonApiData): StorageClass

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Parameters:

    @@ -1270,25 +1270,25 @@

    apiVersion#

    apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:99

    +

    Defined in src/renderer/api/kube-object.ts:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:100

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:101

    +

    Defined in src/renderer/api/kube-object.ts:101


    Optional mountOptions#

    mountOptions? : string[]

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12


    parameters#

    parameters: object

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    Type declaration:#

    @@ -1355,7 +1355,7 @@

    getAge#

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:129

    +

    Defined in src/renderer/api/kube-object.ts:129

    Parameters:

    @@ -1388,7 +1388,7 @@

    getAnnotations#

    getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:150

    +

    Defined in src/renderer/api/kube-object.ts:150

    Parameters:

    @@ -1411,82 +1411,82 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:142

    +

    Defined in src/renderer/api/kube-object.ts:142

    Returns: string[]


    getId#

    getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:108

    +

    Defined in src/renderer/api/kube-object.ts:108

    Returns: string


    getLabels#

    getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:146

    +

    Defined in src/renderer/api/kube-object.ts:146

    Returns: string[]


    getName#

    getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string


    getNs#

    getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string


    getOwnerRefs#

    getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Returns: object[]


    getReclaimPolicy#

    getReclaimPolicy(): string

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    Returns: string


    getResourceVersion#

    getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:112

    +

    Defined in src/renderer/api/kube-object.ts:112

    Returns: string


    getSearchFields#

    getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:169

    +

    Defined in src/renderer/api/kube-object.ts:169

    Returns: string[]


    getTimeDiffFromNow#

    getTimeDiffFromNow(): number

    Inherited from KubeObject.getTimeDiffFromNow

    -

    Defined in src/renderer/api/kube-object.ts:125

    +

    Defined in src/renderer/api/kube-object.ts:125

    Returns: number


    getVolumeBindingMode#

    getVolumeBindingMode(): string

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    Returns: string


    isDefault#

    isDefault(): boolean

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    Returns: boolean


    toPlainObject#

    toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:181

    +

    Defined in src/renderer/api/kube-object.ts:181

    Returns: object


    update#

    updateT›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:186

    +

    Defined in src/renderer/api/kube-object.ts:186

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1509,7 +1509,7 @@

    Static create#

    create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:73

    +

    Defined in src/renderer/api/kube-object.ts:73

    Parameters:

    @@ -1530,7 +1530,7 @@

    Static isJsonApiData#

    isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Parameters:

    @@ -1551,7 +1551,7 @@

    Static isJsonApiDataList#

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Parameters:

    @@ -1572,7 +1572,7 @@

    Static isNonSystem#

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    Parameters:

    @@ -1593,7 +1593,7 @@

    Static stringifyLabels#

    stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html index 7dc47bb466..d735804d22 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -1396,93 +1396,93 @@

    constructor#

    + new StorageClassStore(): StorageClassStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: StorageClassStore

    Properties#

    api#

    api: KubeApiStorageClass‹›› = storageClassApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:9

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:9


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): StorageClass[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: StorageClass[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): StorageClass[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: StorageClass[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1505,7 +1505,7 @@

    create#

    create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1533,7 +1533,7 @@

    createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1560,7 +1560,7 @@

    Protected defaultSorting#

    defaultSorting(item: StorageClass): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1581,7 +1581,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: StorageClass[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1602,7 +1602,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1630,7 +1630,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1651,7 +1651,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): StorageClass[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1673,7 +1673,7 @@

    getByName(name: string, namespace?: string): StorageClass

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1698,7 +1698,7 @@

    getByPath#

    getByPath(path: string): StorageClass

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1719,7 +1719,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1740,12 +1740,12 @@

    getItems#

    getItems(): StorageClass[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: StorageClass[]


    getPersistentVolumes#

    getPersistentVolumes(storageClass: StorageClass): PersistentVolume‹›[]

    -

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:11

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:11

    Parameters:

    @@ -1766,7 +1766,7 @@

    Optional getStatuses#

    getStatuses(items: StorageClass[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1787,20 +1787,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: StorageClass): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1821,7 +1821,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: StorageClass[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1844,7 +1844,7 @@

    load#

    load(params: object): Promise‹StorageClass

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1871,7 +1871,7 @@

    loadAll(options: object): Promise‹void | StorageClass[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1897,7 +1897,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1919,7 +1919,7 @@

    loadItem(params: object): Promise‹StorageClass

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1946,7 +1946,7 @@

    loadItems(__namedParameters: object): Promise‹StorageClass[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1972,7 +1972,7 @@

    Protected mergeItems#

    mergeItems(partialItems: StorageClass[], __namedParameters: object): StorageClass[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: StorageClass[]

    Default value __namedParameters: object= {}

    @@ -2012,7 +2012,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2042,7 +2042,7 @@

    remove#

    remove(item: StorageClass): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2063,7 +2063,7 @@

    Protected removeItem#

    removeItem(item: StorageClass, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: StorageClass

    request: function

    @@ -2074,19 +2074,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:171

    +

    Defined in src/renderer/item.store.ts:171

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2107,13 +2107,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: StorageClass): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2134,7 +2134,7 @@

    Protected sortItems#

    sortItems(items: StorageClass[], sorting?: function[], order?: "asc" | "desc"): StorageClass[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2168,7 +2168,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2191,7 +2191,7 @@

    toggleSelection#

    toggleSelection(item: StorageClass): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2212,7 +2212,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: StorageClass[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2235,7 +2235,7 @@

    unselect#

    unselect(item: StorageClass): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2256,7 +2256,7 @@

    update#

    update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2281,13 +2281,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: StorageClass, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: StorageClass

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html index 980e99fc80..45a01f9436 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -1404,97 +1404,97 @@

    constructor#

    + new VolumeClaimStore(): VolumeClaimStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26

    Returns: VolumeClaimStore

    Properties#

    api#

    api: PersistentVolumeClaimsApi‹› = pvcApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9


    bufferSize#

    bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23


    contextReady#

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    Inherited from KubeObjectStore.contextReady

    -

    Defined in src/renderer/kube-object.store.ts:26

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:261

    +

    Defined in src/renderer/kube-object.store.ts:261


    isLoaded#

    isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17


    isLoading#

    isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16


    items#

    items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18


    Optional limit#

    limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:22

    +

    Defined in src/renderer/kube-object.store.ts:22


    metrics#

    metrics: IPvcMetrics = null

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10


    selectedItemsIds#

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19


    Static defaultContext#

    defaultContext: ClusterContext

    Inherited from KubeObjectStore.defaultContext

    -

    Defined in src/renderer/kube-object.store.ts:19

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    context#

    get context(): ClusterContext

    Inherited from KubeObjectStore.context

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Returns: ClusterContext


    contextItems#

    get contextItems(): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.contextItems

    -

    Defined in src/renderer/kube-object.store.ts:37

    +

    Defined in src/renderer/kube-object.store.ts:37

    Returns: PersistentVolumeClaim[]


    query#

    get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:51

    +

    Defined in src/renderer/kube-object.store.ts:51

    Returns: IKubeApiQueryParams


    selectedItems#

    get selectedItems(): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PersistentVolumeClaim[]

    Methods#

    [Symbol.iterator]#

    [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:186

    +

    Defined in src/renderer/item.store.ts:186

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:263

    +

    Defined in src/renderer/kube-object.store.ts:263

    Parameters:

    @@ -1517,7 +1517,7 @@

    create#

    create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:232

    +

    Defined in src/renderer/kube-object.store.ts:232

    Parameters:

    params: object

    @@ -1545,7 +1545,7 @@

    createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:228

    +

    Defined in src/renderer/kube-object.store.ts:228

    Parameters:

    params: object

    @@ -1572,7 +1572,7 @@

    Protected defaultSorting#

    defaultSorting(item: PersistentVolumeClaim): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1593,7 +1593,7 @@

    Protected filterItemsOnLoad#

    filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:132

    +

    Defined in src/renderer/kube-object.store.ts:132

    Parameters:

    @@ -1614,7 +1614,7 @@

    getAllByNs#

    getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:63

    +

    Defined in src/renderer/kube-object.store.ts:63

    Parameters:

    @@ -1642,7 +1642,7 @@

    getById#

    getById(id: string): T

    Inherited from KubeObjectStore.getById

    -

    Defined in src/renderer/kube-object.store.ts:73

    +

    Defined in src/renderer/kube-object.store.ts:73

    Parameters:

    @@ -1663,7 +1663,7 @@

    getByLabel#

    getByLabel(labels: string[] | object): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Parameters:

    @@ -1685,7 +1685,7 @@

    getByName(name: string, namespace?: string): PersistentVolumeClaim

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:77

    +

    Defined in src/renderer/kube-object.store.ts:77

    Parameters:

    @@ -1710,7 +1710,7 @@

    getByPath#

    getByPath(path: string): PersistentVolumeClaim

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:85

    +

    Defined in src/renderer/kube-object.store.ts:85

    Parameters:

    @@ -1731,7 +1731,7 @@

    getIndexById#

    getIndexById(id: string): number

    Inherited from KubeObjectStore.getIndexById

    -

    Defined in src/renderer/item.store.ts:38

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1752,13 +1752,13 @@

    getItems#

    getItems(): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.getItems

    -

    Defined in src/renderer/item.store.ts:25

    +

    Defined in src/renderer/item.store.ts:25

    Returns: PersistentVolumeClaim[]


    Optional getStatuses#

    getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:61

    +

    Defined in src/renderer/kube-object.store.ts:61

    Parameters:

    @@ -1779,20 +1779,20 @@

    getSubscribeApis#

    getSubscribeApis(): KubeApi[]

    Inherited from KubeObjectStore.getSubscribeApis

    -

    Defined in src/renderer/kube-object.store.ts:269

    +

    Defined in src/renderer/kube-object.store.ts:269

    Returns: KubeApi[]


    getTotalCount#

    getTotalCount(): number

    Inherited from KubeObjectStore.getTotalCount

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:47

    +

    Defined in src/renderer/kube-object.store.ts:47

    Returns: number


    isSelected#

    isSelected(item: PersistentVolumeClaim): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1813,7 +1813,7 @@

    isSelectedAll#

    isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:159

    +

    Defined in src/renderer/item.store.ts:159

    Parameters:

    @@ -1836,7 +1836,7 @@

    load#

    load(params: object): Promise‹PersistentVolumeClaim

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:207

    +

    Defined in src/renderer/kube-object.store.ts:207

    Parameters:

    params: object

    @@ -1863,7 +1863,7 @@

    loadAll(options: object): Promise‹void | PersistentVolumeClaim[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:137

    +

    Defined in src/renderer/kube-object.store.ts:137

    Parameters:

    Default value options: object= {}

    @@ -1889,7 +1889,7 @@

    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:222

    +

    Defined in src/renderer/kube-object.store.ts:222

    Parameters:

    @@ -1911,7 +1911,7 @@

    loadItem(params: object): Promise‹PersistentVolumeClaim

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:202

    +

    Defined in src/renderer/kube-object.store.ts:202

    Parameters:

    params: object

    @@ -1938,7 +1938,7 @@

    loadItems(__namedParameters: object): Promise‹PersistentVolumeClaim[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:106

    +

    Defined in src/renderer/kube-object.store.ts:106

    Parameters:

    __namedParameters: object

    @@ -1963,7 +1963,7 @@

    loadMetrics#

    loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    Parameters:

    @@ -1984,7 +1984,7 @@

    Protected mergeItems#

    mergeItems(partialItems: PersistentVolumeClaim[], __namedParameters: object): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.mergeItems

    -

    Defined in src/renderer/kube-object.store.ts:178

    +

    Defined in src/renderer/kube-object.store.ts:178

    Parameters:

    partialItems: PersistentVolumeClaim[]

    Default value __namedParameters: object= {}

    @@ -2024,7 +2024,7 @@

    reloadAll#

    reloadAll(opts: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.reloadAll

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:167

    Parameters:

    Default value opts: object= {}

    @@ -2054,7 +2054,7 @@

    remove#

    remove(item: PersistentVolumeClaim): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:250

    +

    Defined in src/renderer/kube-object.store.ts:250

    Parameters:

    @@ -2075,7 +2075,7 @@

    Protected removeItem#

    removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:119

    +

    Defined in src/renderer/item.store.ts:119

    Parameters:

    item: PersistentVolumeClaim

    request: function

    @@ -2086,19 +2086,19 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:256

    +

    Defined in src/renderer/kube-object.store.ts:256

    Returns: Promise‹void[]›


    reset#

    reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    Returns: void


    Protected resetOnError#

    resetOnError(error: any): void

    Inherited from KubeObjectStore.resetOnError

    -

    Defined in src/renderer/kube-object.store.ts:198

    +

    Defined in src/renderer/kube-object.store.ts:198

    Parameters:

    @@ -2119,13 +2119,13 @@

    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:166

    +

    Defined in src/renderer/item.store.ts:166

    Returns: void


    select#

    select(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2146,7 +2146,7 @@

    Protected sortItems#

    sortItems(items: PersistentVolumeClaim[], sorting?: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:43

    +

    Defined in src/renderer/item.store.ts:43

    Parameters:

    @@ -2180,7 +2180,7 @@

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:273

    +

    Defined in src/renderer/kube-object.store.ts:273

    Parameters:

    @@ -2203,7 +2203,7 @@

    toggleSelection#

    toggleSelection(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2224,7 +2224,7 @@

    toggleSelectionAll#

    toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:149

    +

    Defined in src/renderer/item.store.ts:149

    Parameters:

    @@ -2247,7 +2247,7 @@

    unselect#

    unselect(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:135

    +

    Defined in src/renderer/item.store.ts:135

    Parameters:

    @@ -2268,7 +2268,7 @@

    update#

    update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:241

    +

    Defined in src/renderer/kube-object.store.ts:241

    Parameters:

    @@ -2293,13 +2293,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:351

    +

    Defined in src/renderer/kube-object.store.ts:351

    Returns: void


    Protected updateItem#

    updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    item: PersistentVolumeClaim

    request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html index 2309f8cde5..8158ec1a54 100644 --- a/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html +++ b/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -1070,7 +1070,7 @@

    Constructors#

    constructor#

    + new PageParam(init: PageParamInit‹V› | PageSystemParamInit‹V›, history: IObservableHistory): PageParam

    -

    Defined in src/renderer/navigation/page-param.ts:23

    +

    Defined in src/renderer/navigation/page-param.ts:23

    Parameters:

    @@ -1094,47 +1094,47 @@

    Properties#

    Protected history#

    history: IObservableHistory

    -

    Defined in src/renderer/navigation/page-param.ts:25

    +

    Defined in src/renderer/navigation/page-param.ts:25


    init#

    init: PageParamInit‹V› | PageSystemParamInit‹V›

    -

    Defined in src/renderer/navigation/page-param.ts:25

    +

    Defined in src/renderer/navigation/page-param.ts:25


    name#

    name: string

    -

    Defined in src/renderer/navigation/page-param.ts:22

    +

    Defined in src/renderer/navigation/page-param.ts:22


    urlName#

    urlName: string

    -

    Defined in src/renderer/navigation/page-param.ts:23

    +

    Defined in src/renderer/navigation/page-param.ts:23


    Static SYSTEM_PREFIX#

    SYSTEM_PREFIX: string = "lens-"

    -

    Defined in src/renderer/navigation/page-param.ts:20

    +

    Defined in src/renderer/navigation/page-param.ts:20

    Methods#

    clear#

    clear(): void

    -

    Defined in src/renderer/navigation/page-param.ts:107

    +

    Defined in src/renderer/navigation/page-param.ts:107

    Returns: void


    get#

    get(): V

    -

    Defined in src/renderer/navigation/page-param.ts:66

    +

    Defined in src/renderer/navigation/page-param.ts:66

    Returns: V


    getDefaultValue#

    getDefaultValue(): V

    -

    Defined in src/renderer/navigation/page-param.ts:101

    +

    Defined in src/renderer/navigation/page-param.ts:101

    Returns: V


    getRaw#

    getRaw(): string[]

    -

    Defined in src/renderer/navigation/page-param.ts:94

    +

    Defined in src/renderer/navigation/page-param.ts:94

    Returns: string[]


    isEmpty#

    isEmpty(value: V | any): boolean

    -

    Defined in src/renderer/navigation/page-param.ts:36

    +

    Defined in src/renderer/navigation/page-param.ts:36

    Parameters:

    @@ -1154,7 +1154,7 @@

    parse#

    parse(values: string[]): V

    -

    Defined in src/renderer/navigation/page-param.ts:40

    +

    Defined in src/renderer/navigation/page-param.ts:40

    Parameters:

    @@ -1174,7 +1174,7 @@

    set#

    set(value: V, __namedParameters: object): void

    -

    Defined in src/renderer/navigation/page-param.ts:76

    +

    Defined in src/renderer/navigation/page-param.ts:76

    Parameters:

    value: V

    Default value __namedParameters: object= {}

    @@ -1203,7 +1203,7 @@

    setRaw#

    setRaw(value: string | string[]): void

    -

    Defined in src/renderer/navigation/page-param.ts:82

    +

    Defined in src/renderer/navigation/page-param.ts:82

    Parameters:

    @@ -1223,7 +1223,7 @@

    stringify#

    stringify(value: V): string

    -

    Defined in src/renderer/navigation/page-param.ts:49

    +

    Defined in src/renderer/navigation/page-param.ts:49

    Parameters:

    @@ -1245,7 +1245,7 @@

    toObjectParam#

    toObjectParam(value: V): Record‹string, V›

    -

    Defined in src/renderer/navigation/page-param.ts:130

    +

    Defined in src/renderer/navigation/page-param.ts:130

    Parameters:

    @@ -1267,7 +1267,7 @@

    toSearchString#

    toSearchString(__namedParameters: object): string

    -

    Defined in src/renderer/navigation/page-param.ts:111

    +

    Defined in src/renderer/navigation/page-param.ts:111

    Parameters:

    Default value __namedParameters: object= {}

    diff --git a/latest/extensions/api/classes/lensmainextension/index.html b/latest/extensions/api/classes/lensmainextension/index.html index 37631cec17..9559160ebe 100644 --- a/latest/extensions/api/classes/lensmainextension/index.html +++ b/latest/extensions/api/classes/lensmainextension/index.html @@ -1094,7 +1094,7 @@

    constructor#

    + new LensMainExtension(__namedParameters: object): LensMainExtension

    Inherited from LensMainExtension.constructor

    -

    Defined in src/extensions/lens-extension.ts:27

    +

    Defined in src/extensions/lens-extension.ts:27

    Parameters:

    __namedParameters: object

    @@ -1127,67 +1127,67 @@

    Properties#

    appMenus#

    appMenus: MenuRegistration[] = []

    -

    Defined in src/extensions/lens-main-extension.ts:7

    +

    Defined in src/extensions/lens-main-extension.ts:7


    id#

    id: LensExtensionId

    Inherited from LensMainExtension.id

    -

    Defined in src/extensions/lens-extension.ts:20

    +

    Defined in src/extensions/lens-extension.ts:20


    isBundled#

    isBundled: boolean

    Inherited from LensMainExtension.isBundled

    -

    Defined in src/extensions/lens-extension.ts:23

    +

    Defined in src/extensions/lens-extension.ts:23


    manifest#

    manifest: LensExtensionManifest

    Inherited from LensMainExtension.manifest

    -

    Defined in src/extensions/lens-extension.ts:21

    +

    Defined in src/extensions/lens-extension.ts:21


    manifestPath#

    manifestPath: string

    Inherited from LensMainExtension.manifestPath

    -

    Defined in src/extensions/lens-extension.ts:22

    +

    Defined in src/extensions/lens-extension.ts:22


    protocolHandlers#

    protocolHandlers: ProtocolHandlerRegistration[] = []

    Inherited from LensMainExtension.protocolHandlers

    -

    Defined in src/extensions/lens-extension.ts:25

    +

    Defined in src/extensions/lens-extension.ts:25

    Accessors#

    description#

    get description(): string

    Inherited from LensMainExtension.description

    -

    Defined in src/extensions/lens-extension.ts:55

    +

    Defined in src/extensions/lens-extension.ts:55

    Returns: string


    name#

    get name(): string

    Inherited from LensMainExtension.name

    -

    Defined in src/extensions/lens-extension.ts:36

    +

    Defined in src/extensions/lens-extension.ts:36

    Returns: string


    version#

    get version(): string

    Inherited from LensMainExtension.version

    -

    Defined in src/extensions/lens-extension.ts:40

    +

    Defined in src/extensions/lens-extension.ts:40

    Returns: string

    Methods#

    disable#

    disable(): Promise‹void›

    Inherited from LensMainExtension.disable

    -

    Defined in src/extensions/lens-extension.ts:68

    +

    Defined in src/extensions/lens-extension.ts:68

    Returns: Promise‹void›


    enable#

    enable(): Promise‹void›

    Inherited from LensMainExtension.enable

    -

    Defined in src/extensions/lens-extension.ts:60

    +

    Defined in src/extensions/lens-extension.ts:60

    Returns: Promise‹void›


    getExtensionFileFolder#

    getExtensionFileFolder(): Promise‹string›

    Inherited from LensMainExtension.getExtensionFileFolder

    -

    Defined in src/extensions/lens-extension.ts:51

    +

    Defined in src/extensions/lens-extension.ts:51

    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 obfiscation of the @@ -1196,7 +1196,7 @@ folder name.


    navigateP›(pageId?: string, params?: P, frameId?: number): Promise‹void›

    -

    Defined in src/extensions/lens-main-extension.ts:9

    +

    Defined in src/extensions/lens-main-extension.ts:9

    Type parameters:

    P: object

    Parameters:

    @@ -1227,19 +1227,19 @@ folder name.

    Protected onActivate#

    onActivate(): void

    Inherited from LensMainExtension.onActivate

    -

    Defined in src/extensions/lens-extension.ts:107

    +

    Defined in src/extensions/lens-extension.ts:107

    Returns: void


    Protected onDeactivate#

    onDeactivate(): void

    Inherited from LensMainExtension.onDeactivate

    -

    Defined in src/extensions/lens-extension.ts:111

    +

    Defined in src/extensions/lens-extension.ts:111

    Returns: void


    toggle#

    toggle(enable?: boolean): void

    Inherited from LensMainExtension.toggle

    -

    Defined in src/extensions/lens-extension.ts:75

    +

    Defined in src/extensions/lens-extension.ts:75

    Parameters:

    @@ -1260,7 +1260,7 @@ folder name.

    whenEnabled#

    whenEnabled(handlers: function): Promise‹(Anonymous function)›

    Inherited from LensMainExtension.whenEnabled

    -

    Defined in src/extensions/lens-extension.ts:83

    +

    Defined in src/extensions/lens-extension.ts:83

    Parameters:

    handlers: function

    ▸ (): Promise‹Function[]›

    diff --git a/latest/extensions/api/classes/lensrendererextension/index.html b/latest/extensions/api/classes/lensrendererextension/index.html index 644ade9623..06d47d5c1e 100644 --- a/latest/extensions/api/classes/lensrendererextension/index.html +++ b/latest/extensions/api/classes/lensrendererextension/index.html @@ -1182,7 +1182,7 @@

    constructor#

    + new LensRendererExtension(__namedParameters: object): LensRendererExtension

    Inherited from LensMainExtension.constructor

    -

    Defined in src/extensions/lens-extension.ts:27

    +

    Defined in src/extensions/lens-extension.ts:27

    Parameters:

    __namedParameters: object

    @@ -1215,107 +1215,107 @@

    Properties#

    appPreferences#

    appPreferences: AppPreferenceRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:13

    +

    Defined in src/extensions/lens-renderer-extension.ts:13


    clusterFeatures#

    clusterFeatures: ClusterFeatureRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:14

    +

    Defined in src/extensions/lens-renderer-extension.ts:14


    clusterPageMenus#

    clusterPageMenus: ClusterPageMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:11

    +

    Defined in src/extensions/lens-renderer-extension.ts:11


    clusterPages#

    clusterPages: PageRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:9

    +

    Defined in src/extensions/lens-renderer-extension.ts:9


    commands#

    commands: CommandRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:18

    +

    Defined in src/extensions/lens-renderer-extension.ts:18


    globalPageMenus#

    globalPageMenus: PageMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:10

    +

    Defined in src/extensions/lens-renderer-extension.ts:10


    globalPages#

    globalPages: PageRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:8

    +

    Defined in src/extensions/lens-renderer-extension.ts:8


    id#

    id: LensExtensionId

    Inherited from LensMainExtension.id

    -

    Defined in src/extensions/lens-extension.ts:20

    +

    Defined in src/extensions/lens-extension.ts:20


    isBundled#

    isBundled: boolean

    Inherited from LensMainExtension.isBundled

    -

    Defined in src/extensions/lens-extension.ts:23

    +

    Defined in src/extensions/lens-extension.ts:23


    kubeObjectDetailItems#

    kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:16

    +

    Defined in src/extensions/lens-renderer-extension.ts:16


    kubeObjectMenuItems#

    kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:17

    +

    Defined in src/extensions/lens-renderer-extension.ts:17


    kubeObjectStatusTexts#

    kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:12

    +

    Defined in src/extensions/lens-renderer-extension.ts:12


    manifest#

    manifest: LensExtensionManifest

    Inherited from LensMainExtension.manifest

    -

    Defined in src/extensions/lens-extension.ts:21

    +

    Defined in src/extensions/lens-extension.ts:21


    manifestPath#

    manifestPath: string

    Inherited from LensMainExtension.manifestPath

    -

    Defined in src/extensions/lens-extension.ts:22

    +

    Defined in src/extensions/lens-extension.ts:22


    protocolHandlers#

    protocolHandlers: ProtocolHandlerRegistration[] = []

    Inherited from LensMainExtension.protocolHandlers

    -

    Defined in src/extensions/lens-extension.ts:25

    +

    Defined in src/extensions/lens-extension.ts:25


    statusBarItems#

    statusBarItems: StatusBarRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:15

    +

    Defined in src/extensions/lens-renderer-extension.ts:15

    Accessors#

    description#

    get description(): string

    Inherited from LensMainExtension.description

    -

    Defined in src/extensions/lens-extension.ts:55

    +

    Defined in src/extensions/lens-extension.ts:55

    Returns: string


    name#

    get name(): string

    Inherited from LensMainExtension.name

    -

    Defined in src/extensions/lens-extension.ts:36

    +

    Defined in src/extensions/lens-extension.ts:36

    Returns: string


    version#

    get version(): string

    Inherited from LensMainExtension.version

    -

    Defined in src/extensions/lens-extension.ts:40

    +

    Defined in src/extensions/lens-extension.ts:40

    Returns: string

    Methods#

    disable#

    disable(): Promise‹void›

    Inherited from LensMainExtension.disable

    -

    Defined in src/extensions/lens-extension.ts:68

    +

    Defined in src/extensions/lens-extension.ts:68

    Returns: Promise‹void›


    enable#

    enable(): Promise‹void›

    Inherited from LensMainExtension.enable

    -

    Defined in src/extensions/lens-extension.ts:60

    +

    Defined in src/extensions/lens-extension.ts:60

    Returns: Promise‹void›


    getExtensionFileFolder#

    getExtensionFileFolder(): Promise‹string›

    Inherited from LensMainExtension.getExtensionFileFolder

    -

    Defined in src/extensions/lens-extension.ts:51

    +

    Defined in src/extensions/lens-extension.ts:51

    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 obfiscation of the @@ -1324,7 +1324,7 @@ folder name.


    isEnabledForCluster#

    isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

    -

    Defined in src/extensions/lens-renderer-extension.ts:34

    +

    Defined in src/extensions/lens-renderer-extension.ts:34

    Defines if extension is enabled for a given cluster. Defaults to true.

    Parameters:

    @@ -1345,7 +1345,7 @@ folder name.


    navigateP›(pageId?: string, params?: P): Promise‹void›

    -

    Defined in src/extensions/lens-renderer-extension.ts:20

    +

    Defined in src/extensions/lens-renderer-extension.ts:20

    Type parameters:

    P: object

    Parameters:

    @@ -1372,19 +1372,19 @@ folder name.

    Protected onActivate#

    onActivate(): void

    Inherited from LensMainExtension.onActivate

    -

    Defined in src/extensions/lens-extension.ts:107

    +

    Defined in src/extensions/lens-extension.ts:107

    Returns: void


    Protected onDeactivate#

    onDeactivate(): void

    Inherited from LensMainExtension.onDeactivate

    -

    Defined in src/extensions/lens-extension.ts:111

    +

    Defined in src/extensions/lens-extension.ts:111

    Returns: void


    toggle#

    toggle(enable?: boolean): void

    Inherited from LensMainExtension.toggle

    -

    Defined in src/extensions/lens-extension.ts:75

    +

    Defined in src/extensions/lens-extension.ts:75

    Parameters:

    @@ -1405,7 +1405,7 @@ folder name.

    whenEnabled#

    whenEnabled(handlers: function): Promise‹(Anonymous function)›

    Inherited from LensMainExtension.whenEnabled

    -

    Defined in src/extensions/lens-extension.ts:83

    +

    Defined in src/extensions/lens-extension.ts:83

    Parameters:

    handlers: function

    ▸ (): Promise‹Function[]›

    diff --git a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html index 96a0f687ba..c1c6545c98 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -892,15 +892,15 @@

    Enumeration members#

    ERROR#

    ERROR: = "error"

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:12

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:12


    INFO#

    INFO: = "info"

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:13

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:13


    OK#

    OK: = "ok"

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:11

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:11

    diff --git a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html index 40ef047096..f9fb337cd1 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -932,35 +932,35 @@

    Enumeration members#

    BOTTOM#

    BOTTOM: = "bottom"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:11

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:11


    BOTTOM_LEFT#

    BOTTOM_LEFT: = "bottom_left"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:16

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:16


    BOTTOM_RIGHT#

    BOTTOM_RIGHT: = "bottom_right"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:17

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:17


    LEFT#

    LEFT: = "left"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:12

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:12


    RIGHT: = "right"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:13

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:13


    TOP#

    TOP: = "top"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:10


    TOP_LEFT#

    TOP_LEFT: = "top_left"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:14

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:14


    TOP_RIGHT#

    TOP_RIGHT: = "top_right"

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:15

    diff --git a/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html index dd1fe540ee..f409a079bf 100644 --- a/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html +++ b/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -892,15 +892,15 @@

    Enumeration members#

    CRITICAL#

    CRITICAL: = 3

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:10

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:10


    INFO#

    INFO: = 1

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:8

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:8


    WARNING#

    WARNING: = 2

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:9

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:9

    diff --git a/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html index 1dd71ba646..df7ae40733 100644 --- a/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html +++ b/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -911,22 +911,22 @@

    Properties#

    canUpgrade#

    canUpgrade: boolean

    -

    Defined in src/extensions/cluster-feature.ts:20

    +

    Defined in src/extensions/cluster-feature.ts:20

    whether the feature can be upgraded or not, as set by the implementation


    currentVersion#

    currentVersion: string

    -

    Defined in src/extensions/cluster-feature.ts:14

    +

    Defined in src/extensions/cluster-feature.ts:14

    feature's current version, as set by the implementation


    installed#

    installed: boolean

    -

    Defined in src/extensions/cluster-feature.ts:18

    +

    Defined in src/extensions/cluster-feature.ts:18

    whether the feature is installed or not, as set by the implementation


    latestVersion#

    latestVersion: string

    -

    Defined in src/extensions/cluster-feature.ts:16

    +

    Defined in src/extensions/cluster-feature.ts:16

    feature's latest version, as set by the implementation

    diff --git a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html index a2796c28f4..8347f85bc4 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -962,47 +962,47 @@

    Properties#

    Optional accessibleNamespaces#

    accessibleNamespaces? : string[]

    -

    Defined in src/common/cluster-store.ts:68

    +

    Defined in src/common/cluster-store.ts:68

    List of accessible namespaces


    Optional contextName#

    contextName? : string

    -

    Defined in src/common/cluster-store.ts:54

    +

    Defined in src/common/cluster-store.ts:54

    User context in kubeconfig


    id#

    id: ClusterId

    -

    Defined in src/common/cluster-store.ts:45

    +

    Defined in src/common/cluster-store.ts:45

    Unique id for a cluster


    Optional kubeConfig#

    kubeConfig? : string

    -

    Defined in src/common/cluster-store.ts:71

    +

    Defined in src/common/cluster-store.ts:71

    deprecated


    kubeConfigPath#

    kubeConfigPath: string

    -

    Defined in src/common/cluster-store.ts:48

    +

    Defined in src/common/cluster-store.ts:48

    Path to cluster kubeconfig


    Optional metadata#

    metadata? : ClusterMetadata

    -

    Defined in src/common/cluster-store.ts:60

    +

    Defined in src/common/cluster-store.ts:60

    Metadata


    Optional ownerRef#

    ownerRef? : string

    -

    Defined in src/common/cluster-store.ts:65

    +

    Defined in src/common/cluster-store.ts:65

    If extension sets ownerRef it has to explicitly mark a cluster as enabled during onActive (or when cluster is saved)


    Optional preferences#

    preferences? : ClusterPreferences

    -

    Defined in src/common/cluster-store.ts:57

    +

    Defined in src/common/cluster-store.ts:57

    Preferences


    Optional workspace#

    workspace? : WorkspaceId

    -

    Defined in src/common/cluster-store.ts:51

    +

    Defined in src/common/cluster-store.ts:51

    Workspace id

    diff --git a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html index 8964a9b418..fb1839edef 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -930,23 +930,23 @@

    Properties#

    Optional description#

    description? : string

    -

    Defined in src/common/workspace-store.ts:20

    +

    Defined in src/common/workspace-store.ts:20


    id#

    id: WorkspaceId

    -

    Defined in src/common/workspace-store.ts:18

    +

    Defined in src/common/workspace-store.ts:18


    Optional lastActiveClusterId#

    lastActiveClusterId? : ClusterId

    -

    Defined in src/common/workspace-store.ts:22

    +

    Defined in src/common/workspace-store.ts:22


    name#

    name: string

    -

    Defined in src/common/workspace-store.ts:19

    +

    Defined in src/common/workspace-store.ts:19


    Optional ownerRef#

    ownerRef? : string

    -

    Defined in src/common/workspace-store.ts:21

    +

    Defined in src/common/workspace-store.ts:21

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html index 7c579a8e61..e47ef57c04 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -895,11 +895,11 @@

    Properties#

    Hint#

    Hint: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/app-preference-registry.ts:5

    +

    Defined in src/extensions/registries/app-preference-registry.ts:5


    Input#

    Input: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/app-preference-registry.ts:6

    +

    Defined in src/extensions/registries/app-preference-registry.ts:6

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html index 11609872a7..00fe271444 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -903,15 +903,15 @@

    Properties#

    components#

    components: AppPreferenceComponents

    -

    Defined in src/extensions/registries/app-preference-registry.ts:12

    +

    Defined in src/extensions/registries/app-preference-registry.ts:12


    Optional id#

    id? : string

    -

    Defined in src/extensions/registries/app-preference-registry.ts:11

    +

    Defined in src/extensions/registries/app-preference-registry.ts:11


    title#

    title: string

    -

    Defined in src/extensions/registries/app-preference-registry.ts:10

    +

    Defined in src/extensions/registries/app-preference-registry.ts:10

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html index 0de9b02b00..8e708145aa 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -887,7 +887,7 @@

    Properties#

    Description#

    Description: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:6

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:6

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html index 8cd39adbe5..045bb4033d 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -903,15 +903,15 @@

    Properties#

    components#

    components: ClusterFeatureComponents

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:11

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:11


    feature#

    feature: ClusterFeature

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:12

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:12


    title#

    title: string

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html index 7fd553d26f..cefb2e8781 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -921,25 +921,25 @@

    components#

    components: PageMenuComponents

    Inherited from PageMenuRegistration.components

    -

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12


    Optional id#

    id? : string

    -

    Defined in src/extensions/registries/page-menu-registry.ts:16

    +

    Defined in src/extensions/registries/page-menu-registry.ts:16


    Optional parentId#

    parentId? : string

    -

    Defined in src/extensions/registries/page-menu-registry.ts:17

    +

    Defined in src/extensions/registries/page-menu-registry.ts:17


    Optional target#

    target? : PageTarget

    Inherited from PageMenuRegistration.target

    -

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10


    title#

    title: React.ReactNode

    Inherited from PageMenuRegistration.title

    -

    Defined in src/extensions/registries/page-menu-registry.ts:11

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html index d75bb2ae57..635f59bc21 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -887,7 +887,7 @@

    Properties#

    Details#

    Details: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:5

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html index 62b24b26a6..5571149dae 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -911,19 +911,19 @@

    Properties#

    apiVersions#

    apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10


    components#

    components: KubeObjectDetailComponents

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11


    kind#

    kind: string

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9


    Optional priority#

    priority? : number

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html index 9ce2d8a5d8..1af7821574 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -887,7 +887,7 @@

    Properties#

    MenuItem: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:5

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html index 1f3d14eee8..24bd2721a7 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -903,15 +903,15 @@

    Properties#

    apiVersions#

    apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10


    components#

    components: KubeObjectMenuComponents

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11


    kind#

    kind: string

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html index 488b28ab9f..c17273d464 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -903,15 +903,15 @@

    Properties#

    apiVersions#

    apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:6

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:6


    kind#

    kind: string

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:5


    resolve#

    resolve: function

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    Type declaration:#

    ▸ (object: KubeObject): KubeObjectStatus

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html index d7381f4e80..8210362fe1 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -896,7 +896,7 @@

    Properties#

    Optional params#

    params? : object

    -

    Defined in src/extensions/registries/page-registry.ts:38

    +

    Defined in src/extensions/registries/page-registry.ts:38

    Type declaration:#

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html index fcc05414ad..5f46ecbffc 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -887,7 +887,7 @@

    Properties#

    Page#

    Page: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/page-registry.ts:24

    +

    Defined in src/extensions/registries/page-registry.ts:24

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html index 9e2c8ef844..d0ecd20a51 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -887,7 +887,7 @@

    Properties#

    Icon#

    Icon: React.ComponentType‹IconProps

    -

    Defined in src/extensions/registries/page-menu-registry.ts:21

    +

    Defined in src/extensions/registries/page-menu-registry.ts:21

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html index 402b7a15a5..d35eea2409 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -904,15 +904,15 @@

    Properties#

    components#

    components: PageMenuComponents

    -

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12


    Optional target#

    target? : PageTarget

    -

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10


    title#

    title: React.ReactNode

    -

    Defined in src/extensions/registries/page-menu-registry.ts:11

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html index e71607a08a..0765ab884a 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -903,17 +903,17 @@

    Properties#

    components#

    components: PageComponents

    -

    Defined in src/extensions/registries/page-registry.ts:17

    +

    Defined in src/extensions/registries/page-registry.ts:17


    Optional id#

    id? : string

    -

    Defined in src/extensions/registries/page-registry.ts:15

    +

    Defined in src/extensions/registries/page-registry.ts:15

    Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension


    Optional params#

    params? : PageParams‹string | ExtensionPageParamInit›

    -

    Defined in src/extensions/registries/page-registry.ts:16

    +

    Defined in src/extensions/registries/page-registry.ts:16

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html index a6865ca1d3..f2cf15968d 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -912,15 +912,15 @@

    Properties#

    Optional extensionId#

    extensionId? : string

    -

    Defined in src/extensions/registries/page-registry.ts:28

    +

    Defined in src/extensions/registries/page-registry.ts:28


    Optional pageId#

    pageId? : string

    -

    Defined in src/extensions/registries/page-registry.ts:29

    +

    Defined in src/extensions/registries/page-registry.ts:29


    Optional params#

    params? : P

    -

    Defined in src/extensions/registries/page-registry.ts:30

    +

    Defined in src/extensions/registries/page-registry.ts:30

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html index 99e0c1af7a..386b80d725 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html @@ -897,11 +897,11 @@ a handler to a specific path or dynamic path.

    Properties#

    handler#

    handler: RouteHandler

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:7

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:7


    pathSchema#

    pathSchema: string

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:6

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:6

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html index 639890cb79..8f833df7b0 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -919,23 +919,23 @@

    Properties#

    components#

    components: PageComponents

    -

    Defined in src/extensions/registries/page-registry.ts:48

    +

    Defined in src/extensions/registries/page-registry.ts:48


    extensionId#

    extensionId: string

    -

    Defined in src/extensions/registries/page-registry.ts:45

    +

    Defined in src/extensions/registries/page-registry.ts:45


    id#

    id: string

    -

    Defined in src/extensions/registries/page-registry.ts:44

    +

    Defined in src/extensions/registries/page-registry.ts:44


    params#

    params: PageParamsPageParam

    -

    Defined in src/extensions/registries/page-registry.ts:47

    +

    Defined in src/extensions/registries/page-registry.ts:47


    url#

    url: string

    -

    Defined in src/extensions/registries/page-registry.ts:46

    +

    Defined in src/extensions/registries/page-registry.ts:46

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html b/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html index ace3d8f8f3..a61aabcb5e 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html @@ -850,7 +850,7 @@

    Callable#

    ▸ (params: RouteParams): void

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:42

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:42

    RouteHandler represents the function signature of the handler function for lens:// protocol routing.

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html b/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html index 5e7a911ce0..65b770eda0 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html @@ -905,17 +905,17 @@ protocol request

    Properties#

    pathname#

    pathname: Record‹string, string›

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:23

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:23

    the matching parts of the path. The dynamic parts of the URI path.


    search: Record‹string, string›

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:18

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:18

    the parts of the URI query string


    Optional tail#

    tail? : string

    -

    Defined in src/extensions/registries/protocol-handler-registry.ts:35

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:35

    if the most specific path schema that is matched does not cover the whole of the URI's path. Then this field will be set to the remaining path segments.

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html index 31e41ffac5..33312f81aa 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -897,11 +897,11 @@

    Optional components#

    components? : StatusBarComponents

    Inherited from StatusBarRegistration.components

    -

    Defined in src/extensions/registries/status-bar-registry.ts:11

    +

    Defined in src/extensions/registries/status-bar-registry.ts:11


    Optional item#

    item? : React.ReactNode

    -

    Defined in src/extensions/registries/status-bar-registry.ts:18

    +

    Defined in src/extensions/registries/status-bar-registry.ts:18

    deprecated use components.Item instead

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html index 50f477a558..85ad0438d8 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -3359,7 +3359,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional flat#

    flat? : boolean

    -

    Defined in src/renderer/components/badge/badge.tsx:9

    +

    Defined in src/renderer/components/badge/badge.tsx:9


    Optional hidden#

    hidden? : boolean

    @@ -3417,7 +3417,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional label#

    label? : React.ReactNode

    -

    Defined in src/renderer/components/badge/badge.tsx:10

    +

    Defined in src/renderer/components/badge/badge.tsx:10


    Optional lang#

    lang? : string

    @@ -4271,7 +4271,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional small#

    small? : boolean

    -

    Defined in src/renderer/components/badge/badge.tsx:8

    +

    Defined in src/renderer/components/badge/badge.tsx:8


    Optional spellCheck#

    spellCheck? : Booleanish

    @@ -4306,12 +4306,12 @@ A hint could be a sample value or a brief description of the expected format.

    Optional tooltip#

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    Inherited from ButtonProps.tooltip

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10


    Optional tooltipOverrideDisabled#

    tooltipOverrideDisabled? : boolean

    Inherited from ButtonProps.tooltipOverrideDisabled

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html index c1a8b88fac..cfba5f4287 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -3122,7 +3122,7 @@

    Optional accent#

    accent? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:10

    +

    Defined in src/renderer/components/button/button.tsx:10


    Optional accessKey#

    accessKey? : string

    @@ -3131,7 +3131,7 @@

    Optional active#

    active? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:15

    +

    Defined in src/renderer/components/button/button.tsx:15


    Optional aria-activedescendant#

    aria-activedescendant? : string

    @@ -3473,7 +3473,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional big#

    big? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:16

    +

    Defined in src/renderer/components/button/button.tsx:16


    Optional children#

    children? : ReactNode

    @@ -3572,11 +3572,11 @@ A hint could be a sample value or a brief description of the expected format.

    Optional hidden#

    hidden? : boolean

    Overrides IconProps.hidden

    -

    Defined in src/renderer/components/button/button.tsx:14

    +

    Defined in src/renderer/components/button/button.tsx:14


    Optional href#

    href? : string

    -

    Defined in src/renderer/components/button/button.tsx:18

    +

    Defined in src/renderer/components/button/button.tsx:18


    Optional id#

    id? : string

    @@ -3629,7 +3629,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional label#

    label? : React.ReactNode

    -

    Defined in src/renderer/components/button/button.tsx:7

    +

    Defined in src/renderer/components/button/button.tsx:7


    Optional lang#

    lang? : string

    @@ -3638,7 +3638,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional light#

    light? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:11

    +

    Defined in src/renderer/components/button/button.tsx:11


    Optional name#

    name? : string

    @@ -4447,7 +4447,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional outlined#

    outlined? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:13

    +

    Defined in src/renderer/components/button/button.tsx:13


    Optional placeholder#

    placeholder? : string

    @@ -4456,7 +4456,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional plain#

    plain? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:12

    +

    Defined in src/renderer/components/button/button.tsx:12


    Optional prefix#

    prefix? : string

    @@ -4465,7 +4465,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional primary#

    primary? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:9

    +

    Defined in src/renderer/components/button/button.tsx:9


    Optional property#

    property? : string

    @@ -4494,7 +4494,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional round#

    round? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:17

    +

    Defined in src/renderer/components/button/button.tsx:17


    Optional security#

    security? : string

    @@ -4533,7 +4533,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional target#

    target? : "_blank"

    -

    Defined in src/renderer/components/button/button.tsx:19

    +

    Defined in src/renderer/components/button/button.tsx:19


    Optional title#

    title? : string

    @@ -4543,12 +4543,12 @@ A hint could be a sample value or a brief description of the expected format.

    Optional tooltip#

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    Inherited from ButtonProps.tooltip

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10


    Optional tooltipOverrideDisabled#

    tooltipOverrideDisabled? : boolean

    Inherited from ButtonProps.tooltipOverrideDisabled

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


    @@ -4584,7 +4584,7 @@ useful for displaying tooltips even when the target is "disabled"


    Optional waiting#

    waiting? : boolean

    -

    Defined in src/renderer/components/button/button.tsx:8

    +

    Defined in src/renderer/components/button/button.tsx:8

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html index bacdf37680..8085f8642f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -967,31 +967,31 @@

    Properties#

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:7

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:7


    Optional disabled#

    disabled? : boolean

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:10

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:10


    Optional inline#

    inline? : boolean

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:9

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:9


    Optional label#

    label? : React.ReactNode

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:8

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:8


    Optional theme#

    theme? : "dark" | "light"

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:6

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:6


    Optional value#

    value? : T

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:11

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:11

    Methods#

    Optional onChange#

    onChange(value: T, evt: ChangeEvent‹HTMLInputElement›): void

    -

    Defined in src/renderer/components/checkbox/checkbox.tsx:12

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:12

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html index ebe760307c..dccb57dc5e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -935,33 +935,33 @@

    Properties#

    Optional cancelButtonProps#

    cancelButtonProps? : Partial‹ButtonProps

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21


    Optional icon#

    icon? : ReactNode

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19


    Optional labelCancel#

    labelCancel? : ReactNode

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17


    Optional labelOk#

    labelOk? : ReactNode

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16


    Optional message#

    message? : ReactNode

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18


    Optional ok#

    ok? : function

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

    Type declaration:#

    ▸ (): void


    Optional okButtonProps#

    okButtonProps? : Partial‹ButtonProps

    -

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html index f43753aadc..9f8e2421bd 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -895,11 +895,11 @@

    Properties#

    Optional center#

    center? : boolean

    -

    Defined in src/renderer/components/spinner/cube-spinner.tsx:7

    +

    Defined in src/renderer/components/spinner/cube-spinner.tsx:7


    Optional className#

    className? : string

    -

    Defined in src/renderer/components/spinner/cube-spinner.tsx:6

    +

    Defined in src/renderer/components/spinner/cube-spinner.tsx:6

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html index 1f1363b149..2067aebb59 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -951,47 +951,47 @@

    Properties#

    Optional animated#

    animated? : boolean

    -

    Defined in src/renderer/components/dialog/dialog.tsx:22

    +

    Defined in src/renderer/components/dialog/dialog.tsx:22


    Optional className#

    className? : string

    -

    Defined in src/renderer/components/dialog/dialog.tsx:14

    +

    Defined in src/renderer/components/dialog/dialog.tsx:14


    Optional close#

    close? : function

    -

    Defined in src/renderer/components/dialog/dialog.tsx:17

    +

    Defined in src/renderer/components/dialog/dialog.tsx:17

    Type declaration:#

    ▸ (): void


    Optional isOpen#

    isOpen? : boolean

    -

    Defined in src/renderer/components/dialog/dialog.tsx:15

    +

    Defined in src/renderer/components/dialog/dialog.tsx:15


    Optional modal#

    modal? : boolean

    -

    Defined in src/renderer/components/dialog/dialog.tsx:20

    +

    Defined in src/renderer/components/dialog/dialog.tsx:20


    Optional onClose#

    onClose? : function

    -

    Defined in src/renderer/components/dialog/dialog.tsx:19

    +

    Defined in src/renderer/components/dialog/dialog.tsx:19

    Type declaration:#

    ▸ (): void


    Optional onOpen#

    onOpen? : function

    -

    Defined in src/renderer/components/dialog/dialog.tsx:18

    +

    Defined in src/renderer/components/dialog/dialog.tsx:18

    Type declaration:#

    ▸ (): void


    Optional open#

    open? : function

    -

    Defined in src/renderer/components/dialog/dialog.tsx:16

    +

    Defined in src/renderer/components/dialog/dialog.tsx:16

    Type declaration:#

    ▸ (): void


    Optional pinned#

    pinned? : boolean

    -

    Defined in src/renderer/components/dialog/dialog.tsx:21

    +

    Defined in src/renderer/components/dialog/dialog.tsx:21

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html index c31b7e6910..1ef2a8f55e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -3292,7 +3292,7 @@ A hint could be a sample value or a brief description of the expected format.

    className? : string

    Inherited from DrawerItemProps.className

    Overrides ButtonProps.className

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7


    Optional color#

    color? : string

    @@ -3347,7 +3347,7 @@ A hint could be a sample value or a brief description of the expected format.

    hidden? : boolean

    Inherited from DrawerItemProps.hidden

    Overrides IconProps.hidden

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10


    Optional id#

    id? : string

    @@ -3400,12 +3400,12 @@ A hint could be a sample value or a brief description of the expected format.

    labels#

    labels: string[]

    -

    Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6

    +

    Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6


    Optional labelsOnly#

    labelsOnly? : boolean

    Inherited from DrawerItemProps.labelsOnly

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:9

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:9


    Optional lang#

    lang? : string

    @@ -3415,7 +3415,7 @@ A hint could be a sample value or a brief description of the expected format.

    name#

    name: React.ReactNode

    Inherited from DrawerItemProps.name

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6


    Optional onAbort#

    onAbort? : ReactEventHandler‹any›

    @@ -4240,7 +4240,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional renderBoolean#

    renderBoolean? : boolean

    Inherited from DrawerItemProps.renderBoolean

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11


    Optional resource#

    resource? : string

    @@ -4296,7 +4296,7 @@ A hint could be a sample value or a brief description of the expected format.

    title? : string

    Inherited from DrawerItemProps.title

    Overrides ButtonProps.title

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8


    Optional translate#

    translate? : "yes" | "no"

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html index 75a46e1ab2..b2e5ab62db 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -3286,7 +3286,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional className#

    className? : string

    Overrides ButtonProps.className

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7


    Optional color#

    color? : string

    @@ -3340,7 +3340,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional hidden#

    hidden? : boolean

    Overrides IconProps.hidden

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10


    Optional id#

    id? : string

    @@ -3393,7 +3393,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional labelsOnly#

    labelsOnly? : boolean

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:9

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:9


    Optional lang#

    lang? : string

    @@ -3402,7 +3402,7 @@ A hint could be a sample value or a brief description of the expected format.

    name#

    name: React.ReactNode

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6


    Optional onAbort#

    onAbort? : ReactEventHandler‹any›

    @@ -4226,7 +4226,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional renderBoolean#

    renderBoolean? : boolean

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11


    Optional resource#

    resource? : string

    @@ -4281,7 +4281,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional title#

    title? : string

    Overrides ButtonProps.title

    -

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8


    Optional translate#

    translate? : "yes" | "no"

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html index 22ec5d97b1..3d291ef1e3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -887,7 +887,7 @@

    Properties#

    label#

    label: string | number

    -

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html index 0b93ae8d44..128684211a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -959,45 +959,45 @@

    Properties#

    Optional animation#

    animation? : AnimateName

    -

    Defined in src/renderer/components/drawer/drawer.tsx:18

    +

    Defined in src/renderer/components/drawer/drawer.tsx:18


    Optional className#

    className? : string | object

    -

    Defined in src/renderer/components/drawer/drawer.tsx:15

    +

    Defined in src/renderer/components/drawer/drawer.tsx:15


    Optional contentClass#

    contentClass? : string | object

    -

    Defined in src/renderer/components/drawer/drawer.tsx:16

    +

    Defined in src/renderer/components/drawer/drawer.tsx:16


    Optional onClose#

    onClose? : function

    -

    Defined in src/renderer/components/drawer/drawer.tsx:19

    +

    Defined in src/renderer/components/drawer/drawer.tsx:19

    Type declaration:#

    ▸ (): void


    open#

    open: boolean

    -

    Defined in src/renderer/components/drawer/drawer.tsx:11

    +

    Defined in src/renderer/components/drawer/drawer.tsx:11


    Optional position#

    position? : "top" | "left" | "right" | "bottom"

    -

    Defined in src/renderer/components/drawer/drawer.tsx:17

    +

    Defined in src/renderer/components/drawer/drawer.tsx:17


    Optional size#

    size? : string

    -

    Defined in src/renderer/components/drawer/drawer.tsx:13

    +

    Defined in src/renderer/components/drawer/drawer.tsx:13


    title#

    title: React.ReactNode

    -

    Defined in src/renderer/components/drawer/drawer.tsx:12

    +

    Defined in src/renderer/components/drawer/drawer.tsx:12


    Optional toolbar#

    toolbar? : React.ReactNode

    -

    Defined in src/renderer/components/drawer/drawer.tsx:20

    +

    Defined in src/renderer/components/drawer/drawer.tsx:20


    Optional usePortal#

    usePortal? : boolean

    -

    Defined in src/renderer/components/drawer/drawer.tsx:14

    +

    Defined in src/renderer/components/drawer/drawer.tsx:14

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html index c663c17c36..be1247ec01 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -895,11 +895,11 @@

    Properties#

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/drawer/drawer-title.tsx:6

    +

    Defined in src/renderer/components/drawer/drawer-title.tsx:6


    Optional title#

    title? : React.ReactNode

    -

    Defined in src/renderer/components/drawer/drawer-title.tsx:7

    +

    Defined in src/renderer/components/drawer/drawer-title.tsx:7

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html index 45813144b0..05bc3f7aa5 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -904,11 +904,11 @@

    Properties#

    label#

    label: ReactNode

    -

    Defined in src/renderer/components/select/select.tsx:16

    +

    Defined in src/renderer/components/select/select.tsx:16


    options#

    options: T[]

    -

    Defined in src/renderer/components/select/select.tsx:17

    +

    Defined in src/renderer/components/select/select.tsx:17

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html index f789bac22a..86fd50d96b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -3047,7 +3047,7 @@

    Optional active#

    active? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:20

    +

    Defined in src/renderer/components/icon/icon.tsx:20


    Optional aria-activedescendant#

    aria-activedescendant? : string

    @@ -3384,7 +3384,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional big#

    big? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:19

    +

    Defined in src/renderer/components/icon/icon.tsx:19


    Optional children#

    children? : ReactNode

    @@ -3442,7 +3442,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional disabled#

    disabled? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:24

    +

    Defined in src/renderer/components/icon/icon.tsx:24


    Optional draggable#

    draggable? : Booleanish

    @@ -3451,7 +3451,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional focusable#

    focusable? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:22

    +

    Defined in src/renderer/components/icon/icon.tsx:22


    Optional hidden#

    hidden? : boolean

    @@ -3460,7 +3460,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional href#

    href? : string

    -

    Defined in src/renderer/components/icon/icon.tsx:15

    +

    Defined in src/renderer/components/icon/icon.tsx:15


    Optional id#

    id? : string

    @@ -3481,7 +3481,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional interactive#

    interactive? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:21

    +

    Defined in src/renderer/components/icon/icon.tsx:21


    Optional is#

    is? : string

    @@ -3522,11 +3522,11 @@ A hint could be a sample value or a brief description of the expected format.

    link? : LocationDescriptor

    -

    Defined in src/renderer/components/icon/icon.tsx:14

    +

    Defined in src/renderer/components/icon/icon.tsx:14


    Optional material#

    material? : string

    -

    Defined in src/renderer/components/icon/icon.tsx:12

    +

    Defined in src/renderer/components/icon/icon.tsx:12


    Optional onAbort#

    onAbort? : ReactEventHandler‹any›

    @@ -4370,7 +4370,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional size#

    size? : string | number

    -

    Defined in src/renderer/components/icon/icon.tsx:16

    +

    Defined in src/renderer/components/icon/icon.tsx:16


    Optional slot#

    slot? : string

    @@ -4379,11 +4379,11 @@ A hint could be a sample value or a brief description of the expected format.

    Optional small#

    small? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:17

    +

    Defined in src/renderer/components/icon/icon.tsx:17


    Optional smallest#

    smallest? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:18

    +

    Defined in src/renderer/components/icon/icon.tsx:18


    Optional spellCheck#

    spellCheck? : Booleanish

    @@ -4392,7 +4392,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional sticker#

    sticker? : boolean

    -

    Defined in src/renderer/components/icon/icon.tsx:23

    +

    Defined in src/renderer/components/icon/icon.tsx:23


    Optional style#

    style? : CSSProperties

    @@ -4411,7 +4411,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional svg#

    svg? : string

    -

    Defined in src/renderer/components/icon/icon.tsx:13

    +

    Defined in src/renderer/components/icon/icon.tsx:13


    Optional tabIndex#

    tabIndex? : number

    @@ -4426,12 +4426,12 @@ A hint could be a sample value or a brief description of the expected format.

    Optional tooltip#

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    Inherited from ButtonProps.tooltip

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10


    Optional tooltipOverrideDisabled#

    tooltipOverrideDisabled? : boolean

    Inherited from ButtonProps.tooltipOverrideDisabled

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html index 71fd37dd2a..cc0f478154 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -934,15 +934,15 @@

    Properties#

    Optional debounce#

    debounce? : number

    -

    Defined in src/renderer/components/input/input_validators.ts:6

    +

    Defined in src/renderer/components/input/input_validators.ts:6


    Optional message#

    message? : ReactNode | function

    -

    Defined in src/renderer/components/input/input_validators.ts:8

    +

    Defined in src/renderer/components/input/input_validators.ts:8

    Methods#

    Optional condition#

    condition(props: InputProps): boolean

    -

    Defined in src/renderer/components/input/input_validators.ts:7

    +

    Defined in src/renderer/components/input/input_validators.ts:7

    Parameters:

    @@ -962,7 +962,7 @@

    validate#

    validate(value: string, props?: InputProps): boolean | Promise‹any›

    -

    Defined in src/renderer/components/input/input_validators.ts:9

    +

    Defined in src/renderer/components/input/input_validators.ts:9

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html index 613ee3d381..ea2375114d 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -887,7 +887,7 @@

    Properties#

    object#

    object: KubeObject

    -

    Defined in src/renderer/components/+events/kube-event-details.tsx:11

    +

    Defined in src/renderer/components/+events/kube-event-details.tsx:11

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html index 5e0dd360ad..130f38c875 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -904,11 +904,11 @@

    Properties#

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:64

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:64


    object#

    object: T

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:65

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:65

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html index d8635f648f..1dfbd4a172 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -1146,22 +1146,22 @@

    Optional addRemoveButtons#

    addRemoveButtons? : Partial‹AddRemoveButtonsProps›

    Inherited from KubeObjectListLayoutProps.addRemoveButtons

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69


    className#

    className: IClassName

    Inherited from KubeObjectListLayoutProps.className

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40


    Optional copyClassNameFromHeadCells#

    copyClassNameFromHeadCells? : boolean

    Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62


    Optional customizeHeader#

    customizeHeader? : function

    Inherited from KubeObjectListLayoutProps.customizeHeader

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

    Type declaration:#

    ▸ (placeholders: IHeaderPlaceholders, content: ReactNode): Partial‹IHeaderPlaceholders› | ReactNode

    Parameters:

    @@ -1187,7 +1187,7 @@

    Optional customizeRemoveDialog#

    customizeRemoveDialog? : function

    Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

    Type declaration:#

    ▸ (selectedItems: T[]): Partial‹ConfirmDialogParams

    Parameters:

    @@ -1209,7 +1209,7 @@

    Optional customizeTableRowProps#

    customizeTableRowProps? : function

    Inherited from KubeObjectListLayoutProps.customizeTableRowProps

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:68

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:68

    Type declaration:#

    ▸ (item: T): Partial‹TableRowProps

    Parameters:

    @@ -1231,68 +1231,68 @@

    Optional dependentStores#

    dependentStores? : KubeObjectStore[]

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15


    Optional detailsItem#

    detailsItem? : T

    Inherited from KubeObjectListLayoutProps.detailsItem

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74


    Optional filterItems#

    filterItems? : ItemsFilter‹T›[]

    Inherited from KubeObjectListLayoutProps.filterItems

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

    deprecated


    Optional hasDetailsView#

    hasDetailsView? : boolean

    Inherited from KubeObjectListLayoutProps.hasDetailsView

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73


    Optional headerClassName#

    headerClassName? : IClassName

    Inherited from KubeObjectListLayoutProps.headerClassName

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53


    Optional hideFilters#

    hideFilters? : boolean

    Inherited from KubeObjectListLayoutProps.hideFilters

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46


    Optional isClusterScoped#

    isClusterScoped? : boolean

    Inherited from KubeObjectListLayoutProps.isClusterScoped

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45


    Optional isConfigurable#

    isConfigurable? : boolean

    Inherited from KubeObjectListLayoutProps.isConfigurable

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61


    Optional isReady#

    isReady? : boolean

    Inherited from KubeObjectListLayoutProps.isReady

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58


    Optional isSearchable#

    isSearchable? : boolean

    Inherited from KubeObjectListLayoutProps.isSearchable

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60


    Optional isSelectable#

    isSelectable? : boolean

    Inherited from KubeObjectListLayoutProps.isSelectable

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59


    Optional items#

    items? : T[]

    Inherited from KubeObjectListLayoutProps.items

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41


    Optional onDetails#

    onDetails? : function

    Inherited from KubeObjectListLayoutProps.onDetails

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

    Type declaration:#

    ▸ (item: T): void

    Parameters:

    @@ -1314,12 +1314,12 @@

    Optional preloadStores#

    preloadStores? : boolean

    Inherited from KubeObjectListLayoutProps.preloadStores

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44


    Optional renderFooter#

    renderFooter? : function

    Inherited from KubeObjectListLayoutProps.renderFooter

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:79

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:79

    Type declaration:#

    ▸ (parent: ItemListLayout): React.ReactNode

    Parameters:

    @@ -1341,12 +1341,12 @@

    Optional renderHeaderTitle#

    renderHeaderTitle? : ReactNode | function

    Inherited from KubeObjectListLayoutProps.renderHeaderTitle

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54


    Optional renderItemMenu#

    renderItemMenu? : function

    Inherited from KubeObjectListLayoutProps.renderItemMenu

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

    Type declaration:#

    ▸ (item: T, store: ItemStore‹T›): ReactNode

    Parameters:

    @@ -1372,7 +1372,7 @@

    renderTableContents#

    renderTableContents: function

    Inherited from KubeObjectListLayoutProps.renderTableContents

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

    Type declaration:#

    ▸ (item: T): (string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹› | TableCellProps‹›)[]

    Parameters:

    @@ -1394,22 +1394,22 @@

    renderTableHeader#

    renderTableHeader: TableCellProps[] | null

    Inherited from KubeObjectListLayoutProps.renderTableHeader

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65


    Optional searchFilters#

    searchFilters? : SearchFilter‹T›[]

    Inherited from KubeObjectListLayoutProps.searchFilters

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47


    Optional showHeader#

    showHeader? : boolean

    Inherited from KubeObjectListLayoutProps.showHeader

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52


    Optional sortingCallbacks#

    sortingCallbacks? : object

    Inherited from KubeObjectListLayoutProps.sortingCallbacks

    -

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

    Type declaration:#

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html index d8e28d8dfd..19f8e061b8 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -904,11 +904,11 @@

    Properties#

    Optional label#

    label? : React.ReactNode

    -

    Defined in src/renderer/components/select/select.tsx:22

    +

    Defined in src/renderer/components/select/select.tsx:22


    value#

    value: T

    -

    Defined in src/renderer/components/select/select.tsx:21

    +

    Defined in src/renderer/components/select/select.tsx:21

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html index 7f21941e29..fa3da4deee 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -1540,7 +1540,7 @@

    Optional autoConvertOptions#

    autoConvertOptions? : boolean

    -

    Defined in src/renderer/components/select/select.tsx:30

    +

    Defined in src/renderer/components/select/select.tsx:30


    Optional autoFocus#

    autoFocus? : boolean

    @@ -1748,7 +1748,7 @@

    Optional isCreatable#

    isCreatable? : boolean

    -

    Defined in src/renderer/components/select/select.tsx:29

    +

    Defined in src/renderer/components/select/select.tsx:29


    Optional isDisabled#

    isDisabled? : boolean

    @@ -1887,7 +1887,7 @@

    Optional menuClass#

    menuClass? : string

    -

    Defined in src/renderer/components/select/select.tsx:28

    +

    Defined in src/renderer/components/select/select.tsx:28


    Optional menuIsOpen#

    menuIsOpen? : boolean

    @@ -2143,17 +2143,17 @@

    Optional themeName#

    themeName? : "dark" | "light" | "outlined"

    -

    Defined in src/renderer/components/select/select.tsx:27

    +

    Defined in src/renderer/components/select/select.tsx:27


    Optional value#

    value? : T

    Overrides void

    -

    Defined in src/renderer/components/select/select.tsx:26

    +

    Defined in src/renderer/components/select/select.tsx:26

    Methods#

    Optional onChange#

    onChange(option: T, meta?: ActionMeta‹any›): void

    Overrides void

    -

    Defined in src/renderer/components/select/select.tsx:31

    +

    Defined in src/renderer/components/select/select.tsx:31

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html index e6850eb614..bd3419fe3e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -919,11 +919,11 @@

    Properties#

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/slider/slider.tsx:10

    +

    Defined in src/renderer/components/slider/slider.tsx:10

    Methods#

    Optional onChange#

    onChange(evt: FormEvent‹any›, value: number): void

    -

    Defined in src/renderer/components/slider/slider.tsx:11

    +

    Defined in src/renderer/components/slider/slider.tsx:11

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html index a939e4c1fa..55a846c9b6 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -4205,11 +4205,11 @@ A hint could be a sample value or a brief description of the expected format.

    Optional center#

    center? : boolean

    -

    Defined in src/renderer/components/spinner/spinner.tsx:8

    +

    Defined in src/renderer/components/spinner/spinner.tsx:8


    Optional centerHorizontal#

    centerHorizontal? : boolean

    -

    Defined in src/renderer/components/spinner/spinner.tsx:9

    +

    Defined in src/renderer/components/spinner/spinner.tsx:9


    Optional challenge#

    challenge? : string

    @@ -5552,7 +5552,7 @@ A hint could be a sample value or a brief description of the expected format.

    Optional singleColor#

    singleColor? : boolean

    -

    Defined in src/renderer/components/spinner/spinner.tsx:7

    +

    Defined in src/renderer/components/spinner/spinner.tsx:7


    Optional size#

    size? : number

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html index 481d2dd84a..8a9802e493 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -4270,12 +4270,12 @@ A hint could be a sample value or a brief description of the expected format.

    Optional tooltip#

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    Inherited from ButtonProps.tooltip

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10


    Optional tooltipOverrideDisabled#

    tooltipOverrideDisabled? : boolean

    Inherited from ButtonProps.tooltipOverrideDisabled

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html index 5297b5ee10..59f609f8a5 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -5579,11 +5579,11 @@ A hint could be a sample value or a brief description of the expected format.

    step#

    step: number

    Overrides LineProgressProps.step

    -

    Defined in src/renderer/components/stepper/stepper.tsx:6

    +

    Defined in src/renderer/components/stepper/stepper.tsx:6


    steps#

    steps: Step[]

    -

    Defined in src/renderer/components/stepper/stepper.tsx:7

    +

    Defined in src/renderer/components/stepper/stepper.tsx:7


    Optional style#

    style? : CSSProperties

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html index 4602c6e22c..021e6518b1 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -911,19 +911,19 @@

    Properties#

    Optional children#

    children? : ReactNode

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:15

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:15


    Optional className#

    className? : IClassName

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:12

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:12


    Optional contentClass#

    contentClass? : IClassName

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:13

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:13


    Optional tabs#

    tabs? : TabLayoutRoute[]

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:14

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:14

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html index 7da263cfa4..4100f223fd 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -927,27 +927,27 @@

    Properties#

    component#

    component: React.ComponentType‹any›

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:21

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:21


    Optional default#

    default? : boolean

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:24

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:24


    Optional exact#

    exact? : boolean

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:23

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:23


    routePath#

    routePath: string

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:19

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:19


    title#

    title: React.ReactNode

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:20

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:20


    Optional url#

    url? : string

    -

    Defined in src/renderer/components/layout/tab-layout.tsx:22

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:22

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html index 18d51095bd..1a450fae1f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -2287,15 +2287,15 @@

    Properties#

    Optional _nowrap#

    _nowrap? : boolean

    -

    Defined in src/renderer/components/table/table-cell.tsx:22

    +

    Defined in src/renderer/components/table/table-cell.tsx:22


    Optional _sorting#

    _sorting? : Partial‹TableSortParams

    -

    Defined in src/renderer/components/table/table-cell.tsx:20

    +

    Defined in src/renderer/components/table/table-cell.tsx:20


    Optional checkbox#

    checkbox? : boolean

    -

    Defined in src/renderer/components/table/table-cell.tsx:15

    +

    Defined in src/renderer/components/table/table-cell.tsx:15


    Optional children#

    children? : ReactNode

    @@ -2304,7 +2304,7 @@

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/table/table-cell.tsx:13

    +

    Defined in src/renderer/components/table/table-cell.tsx:13


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    @@ -2317,11 +2317,11 @@

    Optional id#

    id? : string

    -

    Defined in src/renderer/components/table/table-cell.tsx:12

    +

    Defined in src/renderer/components/table/table-cell.tsx:12


    Optional isChecked#

    isChecked? : boolean

    -

    Defined in src/renderer/components/table/table-cell.tsx:16

    +

    Defined in src/renderer/components/table/table-cell.tsx:16


    Optional onAbort#

    onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3125,23 +3125,23 @@

    Optional renderBoolean#

    renderBoolean? : boolean

    -

    Defined in src/renderer/components/table/table-cell.tsx:17

    +

    Defined in src/renderer/components/table/table-cell.tsx:17


    Optional showWithColumn#

    showWithColumn? : string

    -

    Defined in src/renderer/components/table/table-cell.tsx:19

    +

    Defined in src/renderer/components/table/table-cell.tsx:19


    Optional sortBy#

    sortBy? : TableSortBy

    -

    Defined in src/renderer/components/table/table-cell.tsx:18

    +

    Defined in src/renderer/components/table/table-cell.tsx:18


    Optional title#

    title? : ReactNode

    -

    Defined in src/renderer/components/table/table-cell.tsx:14

    +

    Defined in src/renderer/components/table/table-cell.tsx:14

    Methods#

    Optional _sort#

    _sort(sortBy: TableSortBy): void

    -

    Defined in src/renderer/components/table/table-cell.tsx:21

    +

    Defined in src/renderer/components/table/table-cell.tsx:21

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html index 1ff33021d0..6d2e980d44 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -2213,7 +2213,7 @@

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/table/table-head.tsx:9

    +

    Defined in src/renderer/components/table/table-head.tsx:9


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    @@ -2226,7 +2226,7 @@

    Optional nowrap#

    nowrap? : boolean

    -

    Defined in src/renderer/components/table/table-head.tsx:12

    +

    Defined in src/renderer/components/table/table-head.tsx:12


    Optional onAbort#

    onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3030,11 +3030,11 @@

    Optional showTopLine#

    showTopLine? : boolean

    -

    Defined in src/renderer/components/table/table-head.tsx:10

    +

    Defined in src/renderer/components/table/table-head.tsx:10


    Optional sticky#

    sticky? : boolean

    -

    Defined in src/renderer/components/table/table-head.tsx:11

    +

    Defined in src/renderer/components/table/table-head.tsx:11

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html index a6403f8137..ad9a5130cd 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -2092,6 +2092,13 @@ Optional storageKey + + +
  • + + Optional tableId + +
  • @@ -2307,12 +2314,13 @@
  • sortSyncWithUrl
  • sortable
  • storageKey
  • +
  • tableId
  • virtual
  • Properties#

    Optional autoSize#

    autoSize? : boolean

    -

    Defined in src/renderer/components/table/table.tsx:24

    +

    Defined in src/renderer/components/table/table.tsx:26


    Optional children#

    children? : ReactNode

    @@ -2321,11 +2329,11 @@

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/table/table.tsx:23

    +

    Defined in src/renderer/components/table/table.tsx:25


    Optional customRowHeights#

    customRowHeights? : function

    -

    Defined in src/renderer/components/table/table.tsx:41

    +

    Defined in src/renderer/components/table/table.tsx:43

    Type declaration:#

    ▸ (item: object, lineHeight: number, paddings: number): number

    Parameters:

    @@ -2363,7 +2371,7 @@

    Optional getTableRow#

    getTableRow? : function

    -

    Defined in src/renderer/components/table/table.tsx:42

    +

    Defined in src/renderer/components/table/table.tsx:44

    Type declaration:#

    ▸ (uid: string): ReactElement‹TableRowProps

    Parameters:

    @@ -2384,11 +2392,11 @@

    Optional items#

    items? : ItemObject[]

    -

    Defined in src/renderer/components/table/table.tsx:22

    +

    Defined in src/renderer/components/table/table.tsx:24


    Optional noItems#

    noItems? : React.ReactNode

    -

    Defined in src/renderer/components/table/table.tsx:36

    +

    Defined in src/renderer/components/table/table.tsx:38


    Optional onAbort#

    onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3072,7 +3080,7 @@

    Optional onSort#

    onSort? : function

    -

    Defined in src/renderer/components/table/table.tsx:35

    +

    Defined in src/renderer/components/table/table.tsx:37

    Type declaration:#

    ▸ (params: TableSortParams): void

    Parameters:

    @@ -3213,45 +3221,49 @@

    Optional rowLineHeight#

    rowLineHeight? : string

    -

    Defined in src/renderer/components/table/table.tsx:40

    +

    Defined in src/renderer/components/table/table.tsx:42


    Optional rowPadding#

    rowPadding? : string

    -

    Defined in src/renderer/components/table/table.tsx:39

    +

    Defined in src/renderer/components/table/table.tsx:41


    Optional scrollable#

    scrollable? : boolean

    -

    Defined in src/renderer/components/table/table.tsx:26

    +

    Defined in src/renderer/components/table/table.tsx:28


    Optional selectable#

    selectable? : boolean

    -

    Defined in src/renderer/components/table/table.tsx:25

    +

    Defined in src/renderer/components/table/table.tsx:27


    Optional selectedItemId#

    selectedItemId? : string

    -

    Defined in src/renderer/components/table/table.tsx:37

    +

    Defined in src/renderer/components/table/table.tsx:39


    Optional sortByDefault#

    sortByDefault? : Partial‹TableSortParams

    -

    Defined in src/renderer/components/table/table.tsx:34

    +

    Defined in src/renderer/components/table/table.tsx:36


    Optional sortSyncWithUrl#

    sortSyncWithUrl? : boolean

    -

    Defined in src/renderer/components/table/table.tsx:33

    +

    Defined in src/renderer/components/table/table.tsx:35


    Optional sortable#

    sortable? : TableSortCallbacks

    -

    Defined in src/renderer/components/table/table.tsx:32

    +

    Defined in src/renderer/components/table/table.tsx:34

    Define sortable callbacks for every column in

    sortitem argument in the callback is an object, provided in


    Optional storageKey#

    storageKey? : string

    -

    Defined in src/renderer/components/table/table.tsx:27

    +

    Defined in src/renderer/components/table/table.tsx:29

    +
    +

    Optional tableId#

    +

    tableId? : string

    +

    Defined in src/renderer/components/table/table.tsx:23


    Optional virtual#

    virtual? : boolean

    -

    Defined in src/renderer/components/table/table.tsx:38

    +

    Defined in src/renderer/components/table/table.tsx:40

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html index 5798e90222..e82d7dc3b3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -2237,7 +2237,7 @@

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/table/table-row.tsx:10

    +

    Defined in src/renderer/components/table/table-row.tsx:10


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    @@ -2250,11 +2250,11 @@

    Optional disabled#

    disabled? : boolean

    -

    Defined in src/renderer/components/table/table-row.tsx:16

    +

    Defined in src/renderer/components/table/table-row.tsx:16


    Optional nowrap#

    nowrap? : boolean

    -

    Defined in src/renderer/components/table/table-row.tsx:13

    +

    Defined in src/renderer/components/table/table-row.tsx:13


    Optional onAbort#

    onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3058,19 +3058,19 @@

    Optional searchItem#

    searchItem? : ItemObject | any

    -

    Defined in src/renderer/components/table/table-row.tsx:15

    +

    Defined in src/renderer/components/table/table-row.tsx:15


    Optional selected#

    selected? : boolean

    -

    Defined in src/renderer/components/table/table-row.tsx:11

    +

    Defined in src/renderer/components/table/table-row.tsx:11


    Optional sortItem#

    sortItem? : ItemObject | any

    -

    Defined in src/renderer/components/table/table-row.tsx:14

    +

    Defined in src/renderer/components/table/table-row.tsx:14


    Optional style#

    style? : CSSProperties

    -

    Defined in src/renderer/components/table/table-row.tsx:12

    +

    Defined in src/renderer/components/table/table-row.tsx:12

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html index 53ca66d067..8ae232eff2 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -2241,7 +2241,7 @@

    Properties#

    Optional active#

    active? : boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:56

    +

    Defined in src/renderer/components/tabs/tabs.tsx:56


    Optional children#

    children? : ReactNode

    @@ -2250,7 +2250,7 @@

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/tabs/tabs.tsx:55

    +

    Defined in src/renderer/components/tabs/tabs.tsx:55


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    @@ -2263,19 +2263,19 @@

    Optional disabled#

    disabled? : boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:57

    +

    Defined in src/renderer/components/tabs/tabs.tsx:57


    Optional icon#

    icon? : React.ReactNode | string

    -

    Defined in src/renderer/components/tabs/tabs.tsx:58

    +

    Defined in src/renderer/components/tabs/tabs.tsx:58


    Optional id#

    id? : string

    -

    Defined in src/renderer/components/tabs/tabs.tsx:54

    +

    Defined in src/renderer/components/tabs/tabs.tsx:54


    Optional label#

    label? : React.ReactNode

    -

    Defined in src/renderer/components/tabs/tabs.tsx:59

    +

    Defined in src/renderer/components/tabs/tabs.tsx:59


    Optional onAbort#

    onAbort? : ReactEventHandler‹HTMLElement›

    @@ -3079,7 +3079,7 @@

    value#

    value: D

    -

    Defined in src/renderer/components/tabs/tabs.tsx:60

    +

    Defined in src/renderer/components/tabs/tabs.tsx:60

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html index a010d48231..fa969b28eb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -982,38 +982,38 @@

    Optional autoFocus#

    autoFocus? : boolean

    Inherited from TabsProps.autoFocus

    -

    Defined in src/renderer/components/tabs/tabs.tsx:9

    +

    Defined in src/renderer/components/tabs/tabs.tsx:9


    Optional center#

    center? : boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:19

    +

    Defined in src/renderer/components/tabs/tabs.tsx:19


    Optional className#

    className? : string

    -

    Defined in src/renderer/components/tabs/tabs.tsx:18

    +

    Defined in src/renderer/components/tabs/tabs.tsx:18


    Optional scrollable#

    scrollable? : boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:21

    +

    Defined in src/renderer/components/tabs/tabs.tsx:21


    Optional value#

    value? : D

    Inherited from TabsProps.value

    -

    Defined in src/renderer/components/tabs/tabs.tsx:11

    +

    Defined in src/renderer/components/tabs/tabs.tsx:11


    Optional withBorder#

    withBorder? : boolean

    Inherited from TabsProps.withBorder

    -

    Defined in src/renderer/components/tabs/tabs.tsx:10

    +

    Defined in src/renderer/components/tabs/tabs.tsx:10


    Optional wrap#

    wrap? : boolean

    -

    Defined in src/renderer/components/tabs/tabs.tsx:20

    +

    Defined in src/renderer/components/tabs/tabs.tsx:20

    Methods#

    Optional onChange#

    onChange(value: D): void

    Inherited from TabsProps.onChange

    -

    Defined in src/renderer/components/tabs/tabs.tsx:12

    +

    Defined in src/renderer/components/tabs/tabs.tsx:12

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html index fb1268be0b..b8c5b8b1d9 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -919,23 +919,23 @@

    Properties#

    Optional narrow#

    narrow? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:34

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:34


    Optional nowrap#

    nowrap? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:37

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:37


    Optional small#

    small? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:36

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:36


    Optional tableView#

    tableView? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:38

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:38


    Optional warning#

    warning? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:35

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:35

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html index c2acfd212b..103d2499bf 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -900,11 +900,11 @@

    Properties#

    Optional tooltip#

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10


    Optional tooltipOverrideDisabled#

    tooltipOverrideDisabled? : boolean

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html index 72f12e8be0..d684f70974 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -959,43 +959,43 @@

    Properties#

    Optional children#

    children? : React.ReactNode

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:30

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:30


    Optional className#

    className? : IClassName

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:27

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:27


    Optional formatters#

    formatters? : TooltipContentFormatters

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:28

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:28


    Optional offset#

    offset? : number

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:24

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:24


    Optional preferredPositions#

    preferredPositions? : TooltipPosition | TooltipPosition[]

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:26

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:26


    Optional style#

    style? : CSSProperties

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:29

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:29


    targetId#

    targetId: string

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:21

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:21


    Optional tooltipOnParentHover#

    tooltipOnParentHover? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:22

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:22


    Optional usePortal#

    usePortal? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:25

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:25


    Optional visible#

    visible? : boolean

    -

    Defined in src/renderer/components/tooltip/tooltip.tsx:23

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:23

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html index c71ec251d0..54a4cef248 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -2232,7 +2232,7 @@

    Properties#

    Optional centered#

    centered? : boolean

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:13

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:13


    Optional children#

    children? : ReactNode

    @@ -2241,11 +2241,11 @@

    Optional className#

    className? : IClassName

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:7

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:7


    Optional contentClass#

    contentClass? : IClassName

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:10

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:10


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    @@ -2258,19 +2258,19 @@

    Optional header#

    header? : React.ReactNode

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:8

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:8


    Optional headerClass#

    headerClass? : IClassName

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:9

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:9


    Optional infoPanel#

    infoPanel? : React.ReactNode

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:12

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:12


    Optional infoPanelClass#

    infoPanelClass? : IClassName

    -

    Defined in src/renderer/components/layout/wizard-layout.tsx:11

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:11


    Optional onAbort#

    onAbort? : ReactEventHandler‹any›

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html index ea82b123c4..2e5ac2dc8b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -969,32 +969,32 @@

    Properties#

    Optional className#

    className? : string

    -

    Defined in src/renderer/components/wizard/wizard.tsx:18

    +

    Defined in src/renderer/components/wizard/wizard.tsx:18


    Optional data#

    data? : Partial‹D›

    Inherited from WizardProps.data

    -

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10


    Optional done#

    done? : function

    Inherited from WizardProps.done

    -

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    Type declaration:#

    ▸ (): void


    Optional header#

    header? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:21

    +

    Defined in src/renderer/components/wizard/wizard.tsx:21


    Optional hideSteps#

    hideSteps? : boolean

    Inherited from WizardProps.hideSteps

    -

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14


    Optional onChange#

    onChange? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:22

    +

    Defined in src/renderer/components/wizard/wizard.tsx:22

    Type declaration:#

    ▸ (step: number): void

    Parameters:

    @@ -1016,14 +1016,14 @@

    Optional reset#

    reset? : function

    Inherited from WizardProps.reset

    -

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    Type declaration:#

    ▸ (): void


    Optional save#

    save? : function

    Inherited from WizardProps.save

    -

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    Type declaration:#

    ▸ (data: Partial‹D›, callback?: function): void

    Parameters:

    @@ -1033,11 +1033,11 @@

    Optional step#

    step? : number

    -

    Defined in src/renderer/components/wizard/wizard.tsx:19

    +

    Defined in src/renderer/components/wizard/wizard.tsx:19


    Optional title#

    title? : string

    -

    Defined in src/renderer/components/wizard/wizard.tsx:20

    +

    Defined in src/renderer/components/wizard/wizard.tsx:20

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html index ff6e01fe4a..9641fa789b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -1129,120 +1129,120 @@

    Properties#

    Optional afterContent#

    afterContent? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:122

    +

    Defined in src/renderer/components/wizard/wizard.tsx:122


    Optional beforeContent#

    beforeContent? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:121

    +

    Defined in src/renderer/components/wizard/wizard.tsx:121


    Optional className#

    className? : string | object

    -

    Defined in src/renderer/components/wizard/wizard.tsx:103

    +

    Defined in src/renderer/components/wizard/wizard.tsx:103


    Optional contentClass#

    contentClass? : string | object

    -

    Defined in src/renderer/components/wizard/wizard.tsx:104

    +

    Defined in src/renderer/components/wizard/wizard.tsx:104


    Optional customButtons#

    customButtons? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:105

    +

    Defined in src/renderer/components/wizard/wizard.tsx:105


    Optional data#

    data? : Partial‹D›

    Inherited from WizardProps.data

    -

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10


    Optional disabledNext#

    disabledNext? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:109

    +

    Defined in src/renderer/components/wizard/wizard.tsx:109


    Optional done#

    done? : function

    Inherited from WizardProps.done

    -

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    Type declaration:#

    ▸ (): void


    Optional first#

    first? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:117

    +

    Defined in src/renderer/components/wizard/wizard.tsx:117

    Type declaration:#

    ▸ (): void


    Optional hideBackBtn#

    hideBackBtn? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:111

    +

    Defined in src/renderer/components/wizard/wizard.tsx:111


    Optional hideNextBtn#

    hideNextBtn? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:110

    +

    Defined in src/renderer/components/wizard/wizard.tsx:110


    Optional hideSteps#

    hideSteps? : boolean

    Inherited from WizardProps.hideSteps

    -

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14


    Optional isFirst#

    isFirst? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:119

    +

    Defined in src/renderer/components/wizard/wizard.tsx:119

    Type declaration:#

    ▸ (): boolean


    Optional isLast#

    isLast? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:120

    +

    Defined in src/renderer/components/wizard/wizard.tsx:120

    Type declaration:#

    ▸ (): boolean


    Optional last#

    last? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:118

    +

    Defined in src/renderer/components/wizard/wizard.tsx:118

    Type declaration:#

    ▸ (): void


    Optional loading#

    loading? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:107

    +

    Defined in src/renderer/components/wizard/wizard.tsx:107


    Optional moreButtons#

    moreButtons? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:106

    +

    Defined in src/renderer/components/wizard/wizard.tsx:106


    Optional next#

    next? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:115

    +

    Defined in src/renderer/components/wizard/wizard.tsx:115

    Type declaration:#

    ▸ (): void | boolean | Promise‹any›


    Optional nextLabel#

    nextLabel? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:114

    +

    Defined in src/renderer/components/wizard/wizard.tsx:114


    Optional noValidate#

    noValidate? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:123

    +

    Defined in src/renderer/components/wizard/wizard.tsx:123


    Optional prev#

    prev? : function

    -

    Defined in src/renderer/components/wizard/wizard.tsx:116

    +

    Defined in src/renderer/components/wizard/wizard.tsx:116

    Type declaration:#

    ▸ (): void


    Optional prevLabel#

    prevLabel? : React.ReactNode

    -

    Defined in src/renderer/components/wizard/wizard.tsx:113

    +

    Defined in src/renderer/components/wizard/wizard.tsx:113


    Optional reset#

    reset? : function

    Inherited from WizardProps.reset

    -

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    Type declaration:#

    ▸ (): void


    Optional save#

    save? : function

    Inherited from WizardProps.save

    -

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    Type declaration:#

    ▸ (data: Partial‹D›, callback?: function): void

    Parameters:

    @@ -1252,27 +1252,27 @@

    Optional scrollable#

    scrollable? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:125

    +

    Defined in src/renderer/components/wizard/wizard.tsx:125


    Optional skip#

    skip? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:124

    +

    Defined in src/renderer/components/wizard/wizard.tsx:124


    Optional step#

    step? : number

    -

    Defined in src/renderer/components/wizard/wizard.tsx:112

    +

    Defined in src/renderer/components/wizard/wizard.tsx:112


    Optional title#

    title? : string

    -

    Defined in src/renderer/components/wizard/wizard.tsx:102

    +

    Defined in src/renderer/components/wizard/wizard.tsx:102


    Optional waiting#

    waiting? : boolean

    -

    Defined in src/renderer/components/wizard/wizard.tsx:108

    +

    Defined in src/renderer/components/wizard/wizard.tsx:108


    Optional wizard#

    wizard? : Wizard

    -

    Defined in src/renderer/components/wizard/wizard.tsx:101

    +

    Defined in src/renderer/components/wizard/wizard.tsx:101

    diff --git a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html index e8812a1b7b..8ca7308e81 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -887,7 +887,7 @@

    Properties#

    id#

    id: string

    -

    Defined in src/renderer/api/kube-api.ts:65

    +

    Defined in src/renderer/api/kube-api.ts:65

    diff --git a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html index 4b50ca6e3d..7eaac62770 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -983,47 +983,47 @@

    Properties#

    Optional args#

    args? : string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:69

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:69


    Optional command#

    command? : string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:68

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:68


    Optional env#

    env? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:85

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:85


    Optional envFrom#

    envFrom? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:103

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:103


    image#

    image: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:67

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:67


    imagePullPolicy#

    imagePullPolicy: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:119

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:119


    Optional livenessProbe#

    livenessProbe? : IContainerProbe

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:116

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:116


    name#

    name: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:66


    Optional ports#

    ports? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:70

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:70


    Optional readinessProbe#

    readinessProbe? : IContainerProbe

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:117

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:117


    Optional resources#

    resources? : object

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    Type declaration:#

    @@ -1019,7 +1019,7 @@

    Optional stringify#

    stringify(value: V): string | string[]

    -

    Defined in src/renderer/navigation/page-param.ts:12

    +

    Defined in src/renderer/navigation/page-param.ts:12

    Parameters:

    diff --git a/latest/extensions/api/modules/_core_api_app_/index.html b/latest/extensions/api/modules/_core_api_app_/index.html index f324b7132a..3cb58b2b0b 100644 --- a/latest/extensions/api/modules/_core_api_app_/index.html +++ b/latest/extensions/api/modules/_core_api_app_/index.html @@ -963,39 +963,39 @@

    Variables#

    Const appName#

    appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

    -

    Defined in src/common/vars.ts:15

    +

    Defined in src/common/vars.ts:15


    Const isLinux#

    isLinux: boolean = process.platform === "linux"

    -

    Defined in src/common/vars.ts:8

    +

    Defined in src/common/vars.ts:8


    Const isMac#

    isMac: boolean = process.platform === "darwin"

    -

    Defined in src/common/vars.ts:6

    +

    Defined in src/common/vars.ts:6


    Const isSnap#

    isSnap: boolean = !!process.env.SNAP

    -

    Defined in src/common/vars.ts:10

    +

    Defined in src/common/vars.ts:10


    Const isWindows#

    isWindows: boolean = process.platform === "win32"

    -

    Defined in src/common/vars.ts:7

    +

    Defined in src/common/vars.ts:7


    Const issuesTrackerUrl#

    issuesTrackerUrl: "https://github.com/lensapp/lens/issues" = "https://github.com/lensapp/lens/issues"

    -

    Defined in src/common/vars.ts:43

    +

    Defined in src/common/vars.ts:43


    Const slackUrl#

    slackUrl: "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI" = "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI"

    -

    Defined in src/common/vars.ts:44

    +

    Defined in src/common/vars.ts:44


    Const version#

    version: string = getAppVersion()

    -

    Defined in src/extensions/core-api/app.ts:4

    +

    Defined in src/extensions/core-api/app.ts:4

    Functions#

    getEnabledExtensions#

    getEnabledExtensions(): string[]

    -

    Defined in src/extensions/core-api/app.ts:7

    +

    Defined in src/extensions/core-api/app.ts:7

    Returns: string[]

    diff --git a/latest/extensions/api/modules/_core_api_event_bus_/index.html b/latest/extensions/api/modules/_core_api_event_bus_/index.html index 173b6ffefa..dee726390b 100644 --- a/latest/extensions/api/modules/_core_api_event_bus_/index.html +++ b/latest/extensions/api/modules/_core_api_event_bus_/index.html @@ -907,7 +907,7 @@

    Type aliases#

    AppEvent#

    Ƭ AppEvent: object

    -

    Defined in src/common/event-bus.ts:3

    +

    Defined in src/common/event-bus.ts:3

    Type declaration:#

    @@ -931,7 +931,7 @@

    openExternal#

    openExternal(url: string): Promise‹void›

    -

    Defined in src/common/utils/openExternal.ts:4

    +

    Defined in src/common/utils/openExternal.ts:4

    Parameters:

    @@ -951,7 +951,7 @@

    prevDefault#

    prevDefaultE›(callback: function): (Anonymous function)

    -

    Defined in src/renderer/utils/prevDefault.ts:15

    +

    Defined in src/renderer/utils/prevDefault.ts:15

    Type parameters:

    E: SyntheticEvent | Event

    Parameters:

    @@ -976,7 +976,7 @@

    stopPropagation#

    stopPropagation(evt: Event | SyntheticEvent): void

    -

    Defined in src/renderer/utils/prevDefault.ts:24

    +

    Defined in src/renderer/utils/prevDefault.ts:24

    Parameters:

    diff --git a/latest/extensions/api/modules/_renderer_api_components_/index.html b/latest/extensions/api/modules/_renderer_api_components_/index.html index 8395468769..f7d2cc05c2 100644 --- a/latest/extensions/api/modules/_renderer_api_components_/index.html +++ b/latest/extensions/api/modules/_renderer_api_components_/index.html @@ -1278,47 +1278,47 @@

    Type aliases#

    InputProps#

    Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object

    -

    Defined in src/renderer/components/input/input.tsx:21

    +

    Defined in src/renderer/components/input/input.tsx:21


    Ƭ MenuContextValue: Menu

    -

    Defined in src/renderer/components/menu/menu.tsx:11

    +

    Defined in src/renderer/components/menu/menu.tsx:11


    NotificationId#

    Ƭ NotificationId: string | number

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:7

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:7


    NotificationMessage#

    Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

    -

    Defined in src/renderer/components/notifications/notifications.store.tsx:8

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:8


    RadioProps#

    Ƭ RadioProps: HTMLProps‹any› & object

    -

    Defined in src/renderer/components/radio/radio.tsx:40

    +

    Defined in src/renderer/components/radio/radio.tsx:40


    TableCellElem#

    Ƭ TableCellElem: ReactElement‹TableCellProps

    -

    Defined in src/renderer/components/table/table-cell.tsx:9

    +

    Defined in src/renderer/components/table/table-cell.tsx:9


    TableHeadElem#

    Ƭ TableHeadElem: ReactElement‹TableHeadProps

    -

    Defined in src/renderer/components/table/table-head.tsx:6

    +

    Defined in src/renderer/components/table/table-head.tsx:6


    TableOrderBy#

    Ƭ TableOrderBy: "asc" | "desc" | string

    -

    Defined in src/renderer/components/table/table.tsx:16

    +

    Defined in src/renderer/components/table/table.tsx:17


    TableRowElem#

    Ƭ TableRowElem: ReactElement‹TableRowProps

    -

    Defined in src/renderer/components/table/table-row.tsx:7

    +

    Defined in src/renderer/components/table/table-row.tsx:7


    TableSortBy#

    Ƭ TableSortBy: string

    -

    Defined in src/renderer/components/table/table.tsx:15

    +

    Defined in src/renderer/components/table/table.tsx:16


    TableSortCallback#

    Ƭ TableSortCallback: function

    -

    Defined in src/renderer/components/table/table.tsx:18

    +

    Defined in src/renderer/components/table/table.tsx:19

    Type declaration:#

    ▸ (data: D): string | number | (string | number)[]

    Parameters:

    @@ -1339,7 +1339,7 @@

    TableSortCallbacks#

    Ƭ TableSortCallbacks: object

    -

    Defined in src/renderer/components/table/table.tsx:19

    +

    Defined in src/renderer/components/table/table.tsx:20

    Type declaration:#

    @@ -1470,7 +1470,7 @@ last clicked Node should be "active" while Pod details are shown).


    SubMenu(props: Partial‹MenuProps›): Element‹›

    -

    Defined in src/renderer/components/menu/menu.tsx:289

    +

    Defined in src/renderer/components/menu/menu.tsx:289

    Parameters:

    @@ -1490,7 +1490,7 @@ last clicked Node should be "active" while Pod details are shown).


    createTerminalTab#

    createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

    -

    Defined in src/renderer/components/dock/terminal.store.ts:16

    +

    Defined in src/renderer/components/dock/terminal.store.ts:16

    Parameters:

    @@ -1512,7 +1512,7 @@ last clicked Node should be "active" while Pod details are shown).


    getDetailsUrl#

    getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    Parameters:

    @@ -1544,12 +1544,12 @@ last clicked Node should be "active" while Pod details are shown).


    hideDetails#

    hideDetails(): void

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    Returns: void


    showDetails#

    showDetails(selfLink: string, resetSelected: boolean): void

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    Parameters:

    @@ -1576,7 +1576,7 @@ last clicked Node should be "active" while Pod details are shown).


    withTooltip#

    withTooltipT›(Target: T): T

    -

    Defined in src/renderer/components/tooltip/withTooltip.tsx:18

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:18

    Type parameters:

    T: React.ComponentType‹any›

    Parameters:

    diff --git a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html index f37aeb324f..12c6af23f0 100644 --- a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -1278,7 +1278,7 @@

    Type aliases#

    KubeObjectStatus#

    Ƭ KubeObjectStatus: object

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:1

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:1

    Type declaration:#

    diff --git a/latest/extensions/api/modules/_renderer_api_navigation_/index.html b/latest/extensions/api/modules/_renderer_api_navigation_/index.html index 78a0617384..bfa34f7c11 100644 --- a/latest/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/latest/extensions/api/modules/_renderer_api_navigation_/index.html @@ -939,7 +939,7 @@

    Functions#

    createPageParam#

    createPageParamV›(init: PageParamInit‹V›): PageParam‹V›

    -

    Defined in src/extensions/renderer-api/navigation.ts:10

    +

    Defined in src/extensions/renderer-api/navigation.ts:10

    Type parameters:

    V

    Parameters:

    @@ -961,7 +961,7 @@

    getDetailsUrl#

    getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    Parameters:

    @@ -993,12 +993,12 @@

    hideDetails#

    hideDetails(): void

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    Returns: void


    isActiveRoute#

    isActiveRoute(route: string | string[] | RouteProps): boolean

    -

    Defined in src/renderer/navigation/helpers.ts:25

    +

    Defined in src/renderer/navigation/helpers.ts:25

    Parameters:

    @@ -1018,7 +1018,7 @@

    navigate(location: LocationDescriptor): void

    -

    Defined in src/renderer/navigation/helpers.ts:7

    +

    Defined in src/renderer/navigation/helpers.ts:7

    Parameters:

    @@ -1038,7 +1038,7 @@

    showDetails#

    showDetails(selfLink: string, resetSelected: boolean): void

    -

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    Parameters:

    diff --git a/latest/extensions/api/modules/_renderer_api_theming_/index.html b/latest/extensions/api/modules/_renderer_api_theming_/index.html index 17407fdef4..f0cab8bf33 100644 --- a/latest/extensions/api/modules/_renderer_api_theming_/index.html +++ b/latest/extensions/api/modules/_renderer_api_theming_/index.html @@ -876,7 +876,7 @@

    Functions#

    getActiveTheme#

    getActiveTheme(): Theme

    -

    Defined in src/extensions/renderer-api/theming.ts:3

    +

    Defined in src/extensions/renderer-api/theming.ts:3

    Returns: Theme

    diff --git a/latest/search/search_index.json b/latest/search/search_index.json index 63529a08cf..174fb015f5 100644 --- a/latest/search/search_index.json +++ b/latest/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example # If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label
    + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the resources are to be applied to
    resourceSpecstring | string[]as a string type this is a folder path that is searched for files specifying kubernetes resources. The files are read and if any of the resource files are templated, the template parameters are filled using the templateContext field (See renderTemplate() method). Finally the resources are applied to the cluster. As a string[] type resourceSpec is treated as an array of fully formed (not templated) kubernetes resources that are applied to the cluster
    +

    Returns: Promise‹void›

    +
    +

    Abstract install#

    +

    install(cluster: Cluster): Promise‹void›

    +

    Defined in src/extensions/cluster-feature.ts:47

    +

    to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be installed. The implementation +of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi)

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be installed on
    +

    Returns: Promise‹void›

    +
    +

    Protected renderTemplates#

    +

    renderTemplates(folderPath: string): string[]

    +

    Defined in src/extensions/cluster-feature.ts:109

    +

    this is a helper method that conveniently reads kubernetes resource files into a string array. It also fills templated resource files with the template parameter values +specified by the templateContext field. Templated files must end with the extension '.hb' and the template syntax must be compatible with handlebars.js

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    folderPathstringthis is a folder path that is searched for files defining kubernetes resources.
    +

    Returns: string[]

    +

    an array of strings, each string being the contents of a resource file found in the folder path. This can be passed directly to applyResources()

    +
    +

    Abstract uninstall#

    +

    uninstall(cluster: Cluster): Promise‹void›

    +

    Defined in src/extensions/cluster-feature.ts:63

    +

    to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be uninstalled. The implementation +of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be uninstalled from
    +

    Returns: Promise‹void›

    +
    +

    Abstract updateStatus#

    +

    updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus

    +

    Defined in src/extensions/cluster-feature.ts:75

    +

    to be implemented in the derived class, this method is called periodically by Lens to determine details about the feature's current status. The implementation +of this method should provide the current status information. The currentVersion and latestVersion fields may be displayed by Lens in describing the feature. +The installed field should be set to true if the feature has been installed, otherwise false. Also, Lens relies on the canUpgrade field to determine if the feature +can be upgraded so the implementation should set the canUpgrade field according to specific rules for the feature, if relevant.

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature may be installed on
    +

    Returns: Promise‹ClusterFeatureStatus

    +

    a promise, resolved with the updated ClusterFeatureStatus

    +
    +

    Abstract upgrade#

    +

    upgrade(cluster: Cluster): Promise‹void›

    +

    Defined in src/extensions/cluster-feature.ts:55

    +

    to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be upgraded. The implementation +of this method should upgrade the kubernetes resources already installed, if relevant to the feature

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be upgraded on
    +

    Returns: Promise‹void›

    +

    Object literals#

    +

    status#

    +

    status: object#

    +

    Defined in src/extensions/cluster-feature.ts:34

    +

    this field holds the current feature status, is accessed directly by Lens

    +

    canUpgrade#

    +

    canUpgrade: false = false

    +

    Defined in src/extensions/cluster-feature.ts:38

    +

    currentVersion#

    +

    currentVersion: null = null

    +

    Defined in src/extensions/cluster-feature.ts:35

    +

    installed#

    +

    installed: false = false

    +

    Defined in src/extensions/cluster-feature.ts:36

    +

    latestVersion#

    +

    latestVersion: null = null

    +

    Defined in src/extensions/cluster-feature.ts:37

    + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_stores_.cluster/index.html b/v4.2.1/extensions/api/classes/_core_api_stores_.cluster/index.html new file mode 100644 index 0000000000..5cf50e1ee8 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -0,0 +1,2184 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Cluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Cluster#

    +

    Cluster

    +

    beta

    +

    Hierarchy#

    +
      +
    • Cluster
    • +
    +

    Implements#

    + +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Cluster(model: ClusterModel): Cluster

    +

    Defined in src/main/cluster.ts:256

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelClusterModel
    +

    Returns: Cluster

    +

    Properties#

    +

    accessible#

    +

    accessible: boolean = false

    +

    Defined in src/main/cluster.ts:149

    +

    Can user access cluster resources

    +

    observable

    +
    +

    accessibleNamespaces#

    +

    accessibleNamespaces: string[] = []

    +

    Implementation of ClusterModel.accessibleNamespaces

    +

    Defined in src/main/cluster.ts:217

    +

    List of accessible namespaces provided by user in the Cluster Settings

    +

    observable

    +
    +

    Protected activated#

    +

    activated: boolean = false

    +

    Defined in src/main/cluster.ts:82

    +
    +

    allowedNamespaces#

    +

    allowedNamespaces: string[] = []

    +

    Defined in src/main/cluster.ts:204

    +

    List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

    +

    observable

    +
    +

    allowedResources#

    +

    allowedResources: string[] = []

    +

    Defined in src/main/cluster.ts:211

    +

    List of allowed resources

    +

    observable

    +

    internal

    +
    +

    apiUrl#

    +

    apiUrl: string

    +

    Defined in src/main/cluster.ts:124

    +

    Kubernetes API server URL

    +

    observable

    +
    +

    contextHandler#

    +

    contextHandler: ContextHandler

    +

    Defined in src/main/cluster.ts:73

    +

    Context handler

    +

    internal

    +
    +

    contextName#

    +

    contextName: string

    +

    Implementation of ClusterModel.contextName

    +

    Defined in src/main/cluster.ts:106

    +

    Kubeconfig context name

    +

    observable

    +
    +

    disconnected#

    +

    disconnected: boolean = true

    +

    Defined in src/main/cluster.ts:167

    +

    Is cluster disconnected. False if user has selected to connect.

    +

    observable

    +
    +

    enabled#

    +

    enabled: boolean = false

    +

    Defined in src/main/cluster.ts:137

    +

    Is cluster instance enabled (disabled clusters are currently hidden)

    +

    observable

    +
    +

    Protected eventDisposers#

    +

    eventDisposers: Function[] = []

    +

    Defined in src/main/cluster.ts:81

    +
    +

    failureReason#

    +

    failureReason: string

    +

    Defined in src/main/cluster.ts:173

    +

    Connection failure reason

    +

    observable

    +
    +

    id#

    +

    id: ClusterId

    +

    Implementation of ClusterModel.id

    +

    Defined in src/main/cluster.ts:61

    +

    Unique id for a cluster

    +
    +

    initialized#

    +

    initialized: boolean = false

    +

    Defined in src/main/cluster.ts:100

    +

    Is cluster object initialized

    +

    observable

    +
    +

    initializing#

    +

    initializing: boolean = false

    +

    Defined in src/main/cluster.ts:93

    +

    Is cluster object initializinng on-going

    +

    observable

    +
    +

    isAdmin#

    +

    isAdmin: boolean = false

    +

    Defined in src/main/cluster.ts:179

    +

    Does user have admin like access

    +

    observable

    +
    +

    isGlobalWatchEnabled#

    +

    isGlobalWatchEnabled: boolean = false

    +

    Defined in src/main/cluster.ts:186

    +

    Global watch-api accessibility , e.g. "/api/v1/services?watch=1"

    +

    observable

    +
    +

    kubeConfigPath#

    +

    kubeConfigPath: string

    +

    Implementation of ClusterModel.kubeConfigPath

    +

    Defined in src/main/cluster.ts:118

    +

    Path to kubeconfig

    +

    observable

    +
    +

    kubeCtl#

    +

    kubeCtl: Kubectl

    +

    Defined in src/main/cluster.ts:67

    +

    Kubectl

    +

    internal

    +
    +

    kubeProxyUrl#

    +

    kubeProxyUrl: string

    +

    Defined in src/main/cluster.ts:131

    +

    Internal authentication proxy URL

    +

    observable

    +

    internal

    +
    +

    Protected kubeconfigManager#

    +

    kubeconfigManager: KubeconfigManager

    +

    Defined in src/main/cluster.ts:80

    +
    +

    metadata#

    +

    metadata: ClusterMetadata

    +

    Implementation of ClusterModel.metadata

    +

    Defined in src/main/cluster.ts:198

    +

    Metadata

    +

    observable

    +
    +

    online#

    +

    online: boolean = false

    +

    Defined in src/main/cluster.ts:143

    +

    Is cluster online

    +

    observable

    +
    +

    ownerRef#

    +

    ownerRef: string

    +

    Implementation of ClusterModel.ownerRef

    +

    Defined in src/main/cluster.ts:79

    +

    Owner reference

    +

    If extension sets this it needs to also mark cluster as enabled on activate (or when added to a store)

    +
    +

    preferences#

    +

    preferences: ClusterPreferences

    +

    Implementation of ClusterModel.preferences

    +

    Defined in src/main/cluster.ts:192

    +

    Preferences

    +

    observable

    +
    +

    ready#

    +

    ready: boolean = false

    +

    Defined in src/main/cluster.ts:155

    +

    Is cluster instance in usable state

    +

    observable

    +
    +

    reconnecting#

    +

    reconnecting: boolean = false

    +

    Defined in src/main/cluster.ts:161

    +

    Is cluster currently reconnecting

    +

    observable

    +
    +

    whenInitialized#

    +

    whenInitialized: Promise‹void› & object = when(() => this.initialized)

    +

    Defined in src/main/cluster.ts:85

    +
    +

    whenReady#

    +

    whenReady: Promise‹void› & object = when(() => this.ready)

    +

    Defined in src/main/cluster.ts:86

    +
    +

    workspace#

    +

    workspace: WorkspaceId

    +

    Implementation of ClusterModel.workspace

    +

    Defined in src/main/cluster.ts:112

    +

    Workspace id

    +

    observable

    +

    Accessors#

    +

    available#

    +

    get available(): boolean

    +

    Defined in src/main/cluster.ts:224

    +

    Is cluster available

    +

    computed

    +

    Returns: boolean

    +
    +

    isManaged#

    +

    get isManaged(): boolean

    +

    Defined in src/main/cluster.ts:276

    +

    Is cluster managed by an extension

    +

    Returns: boolean

    +
    +

    name#

    +

    get name(): string

    +

    Defined in src/main/cluster.ts:233

    +

    Cluster name

    +

    computed

    +

    Returns: string

    +
    +

    prometheusPreferences#

    +

    get prometheusPreferences(): ClusterPrometheusPreferences

    +

    Defined in src/main/cluster.ts:243

    +

    Prometheus preferences

    +

    computed

    +

    internal

    +

    Returns: ClusterPrometheusPreferences

    +
    +

    version#

    +

    get version(): string

    +

    Defined in src/main/cluster.ts:254

    +

    Kubernetes version

    +

    Returns: string

    +

    Methods#

    +

    activate#

    +

    activate(force: boolean): Promise‹void›

    +

    Defined in src/main/cluster.ts:352

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    forcebooleanfalseforce activation
    +

    Returns: Promise‹void›

    +
    +

    Protected bindEvents#

    +

    bindEvents(): void

    +

    Defined in src/main/cluster.ts:321

    +

    internal

    +

    Returns: void

    +
    +

    canI#

    +

    canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:569

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    resourceAttributesV1ResourceAttributesresource attributes
    +

    Returns: Promise‹boolean›

    +
    +

    canUseWatchApi#

    +

    canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:601

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    customizeResourceV1ResourceAttributes{}
    +

    Returns: Promise‹boolean›

    +
    +

    disconnect#

    +

    disconnect(): void

    +

    Defined in src/main/cluster.ts:400

    +

    internal

    +

    Returns: void

    +
    +

    Protected ensureKubectl#

    +

    ensureKubectl(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:380

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected getAllowedNamespaces#

    +

    getAllowedNamespaces(): Promise‹string[]›

    +

    Defined in src/main/cluster.ts:680

    +

    Returns: Promise‹string[]›

    +
    +

    Protected getAllowedResources#

    +

    getAllowedResources(): Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

    +

    Defined in src/main/cluster.ts:704

    +

    Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

    +
    +

    Protected getConnectionStatus#

    +

    getConnectionStatus(): Promise‹ClusterStatus›

    +

    Defined in src/main/cluster.ts:525

    +

    Returns: Promise‹ClusterStatus›

    +
    +

    Protected getKubeconfig#

    +

    getKubeconfig(): KubeConfig

    +

    Defined in src/main/cluster.ts:478

    +

    Returns: KubeConfig

    +
    +

    getMeta#

    +

    getMeta(): object

    +

    Defined in src/main/cluster.ts:668

    +

    Returns: object

    +
      +
    • +

      accessible: boolean = this.accessible

      +
    • +
    • +

      disconnected: boolean = this.disconnected

      +
    • +
    • +

      id: string = this.id

      +
    • +
    • +

      initialized: boolean = this.initialized

      +
    • +
    • +

      name: string = this.contextName

      +
    • +
    • +

      online: boolean = this.online

      +
    • +
    • +

      ready: boolean = this.ready

      +
    • +
    +
    +

    getMetrics#

    +

    getMetrics(prometheusPath: string, queryParams: IMetricsReqParams & object): Promise‹any›

    +

    Defined in src/main/cluster.ts:513

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    prometheusPathstringpath to prometheus service
    queryParamsIMetricsReqParams & objectquery parameters
    +

    Returns: Promise‹any›

    +
    +

    getProxyKubeconfig#

    +

    getProxyKubeconfig(): Promise‹KubeConfig›

    +

    Defined in src/main/cluster.ts:485

    +

    internal

    +

    Returns: Promise‹KubeConfig›

    +
    +

    getProxyKubeconfigPath#

    +

    getProxyKubeconfigPath(): Promise‹string›

    +

    Defined in src/main/cluster.ts:494

    +

    internal

    +

    Returns: Promise‹string›

    +
    +

    getState#

    +

    getState(): ClusterState

    +

    Defined in src/main/cluster.ts:629

    +

    Serializable cluster-state used for sync btw main <-> renderer

    +

    Returns: ClusterState

    +
    +

    init#

    +

    init(port: number): Promise‹void›

    +

    Defined in src/main/cluster.ts:296

    +

    Initialize a cluster (can be done only in main process)

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    portnumberport where internal auth proxy is listening
    +

    Returns: Promise‹void›

    +
    +

    isAllowedResource#

    +

    isAllowedResource(kind: string): boolean

    +

    Defined in src/main/cluster.ts:739

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    kindstring
    +

    Returns: boolean

    +
    +

    isClusterAdmin#

    +

    isClusterAdmin(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:590

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected k8sRequest#

    +

    k8sRequestT›(path: string, options: RequestPromiseOptions): Promise‹T›

    +

    Defined in src/main/cluster.ts:498

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    pathstring-
    optionsRequestPromiseOptions{}
    +

    Returns: Promise‹T›

    +
    +

    pushState#

    +

    pushState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:662

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    stateClusterStatethis.getState()cluster state
    +

    Returns: void

    +
    +

    reconnect#

    +

    reconnect(): Promise‹void›

    +

    Defined in src/main/cluster.ts:390

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refresh#

    +

    refresh(opts: ClusterRefreshOptions): Promise‹void›

    +

    Defined in src/main/cluster.ts:419

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    optsClusterRefreshOptions{}refresh options
    +

    Returns: Promise‹void›

    +
    +

    refreshAllowedResources#

    +

    refreshAllowedResources(): Promise‹void›

    +

    Defined in src/main/cluster.ts:473

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshConnectionStatus#

    +

    refreshConnectionStatus(): Promise‹void›

    +

    Defined in src/main/cluster.ts:462

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshMetadata#

    +

    refreshMetadata(): Promise‹void›

    +

    Defined in src/main/cluster.ts:438

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    setState#

    +

    setState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:654

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateClusterStatecluster state
    +

    Returns: void

    +
    +

    toJSON#

    +

    toJSON(): ClusterModel

    +

    Defined in src/main/cluster.ts:609

    +

    Returns: ClusterModel

    +
    +

    Protected unbindEvents#

    +

    unbindEvents(): void

    +

    Defined in src/main/cluster.ts:341

    +

    internal

    +

    Returns: void

    +
    +

    updateModel#

    +

    updateModel(model: ClusterModel): void

    +

    Defined in src/main/cluster.ts:285

    +

    Update cluster data model

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModel
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/v4.2.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html new file mode 100644 index 0000000000..43b06fd408 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -0,0 +1,1346 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterStore#

    +

    Store for all added clusters

    +

    beta

    +

    Hierarchy#

    + +

    ClusterStore

    +

    Index#

    +

    Accessors#

    + +

    Methods#

    + +

    Accessors#

    +

    activeCluster#

    +

    get activeCluster(): Cluster | null

    +

    Defined in src/extensions/stores/cluster-store.ts:41

    +

    Get active cluster (a cluster which is currently visible)

    +

    Returns: Cluster | null

    +
    +

    activeClusterId#

    +

    get activeClusterId(): string

    +

    Defined in src/extensions/stores/cluster-store.ts:20

    +

    Active cluster id

    +

    Returns: string

    +

    set activeClusterId(id: ClusterId): void

    +

    Defined in src/extensions/stores/cluster-store.ts:27

    +

    Set active cluster id

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idClusterId
    +

    Returns: void

    +
    +

    clusters#

    +

    get clusters(): ObservableMap‹string, Cluster

    +

    Defined in src/extensions/stores/cluster-store.ts:34

    +

    Map of all clusters

    +

    Returns: ObservableMap‹string, Cluster

    +
    +

    clustersList#

    +

    get clustersList(): Cluster[]

    +

    Defined in src/extensions/stores/cluster-store.ts:48

    +

    Array of all clusters

    +

    Returns: Cluster[]

    +
    +

    connectedClustersList#

    +

    get connectedClustersList(): Cluster[]

    +

    Defined in src/extensions/stores/cluster-store.ts:62

    +

    Array of all clusters that have active connection to a Kubernetes cluster

    +

    Returns: Cluster[]

    +
    +

    enabledClustersList#

    +

    get enabledClustersList(): Cluster[]

    +

    Defined in src/extensions/stores/cluster-store.ts:55

    +

    Array of all enabled clusters

    +

    Returns: Cluster[]

    +

    Methods#

    +

    addCluster#

    +

    addCluster(model: ClusterModel | Cluster): Cluster

    +

    Defined in src/extensions/stores/cluster-store.ts:94

    +

    Add a cluster to store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModel | Clustercluster
    +

    Returns: Cluster

    +
    +

    addClusters#

    +

    addClusters(...models: ClusterModel[]): Cluster[]

    +

    Defined in src/extensions/stores/cluster-store.ts:86

    +

    Add clusters to store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    ...modelsClusterModel[]list of cluster models
    +

    Returns: Cluster[]

    +
    +

    getById#

    +

    getById(id: ClusterId): Cluster

    +

    Defined in src/extensions/stores/cluster-store.ts:70

    +

    Get cluster object by cluster id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    idClusterIdcluster id
    +

    Returns: Cluster

    +
    +

    getByWorkspaceId#

    +

    getByWorkspaceId(workspaceId: string): Cluster[]

    +

    Defined in src/extensions/stores/cluster-store.ts:78

    +

    Get all clusters belonging to a workspace

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceIdstringworkspace id
    +

    Returns: Cluster[]

    +
    +

    removeById#

    +

    removeById(clusterId: ClusterId): Promise‹void›

    +

    Defined in src/extensions/stores/cluster-store.ts:110

    +

    Remove a cluster from store by id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterIdClusterIdcluster id
    +

    Returns: Promise‹void›

    +
    +

    removeByWorkspaceId#

    +

    removeByWorkspaceId(workspaceId: string): void

    +

    Defined in src/extensions/stores/cluster-store.ts:118

    +

    Remove all clusters belonging to a workspaces

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceIdstringworkspace id
    +

    Returns: void

    +
    +

    removeCluster#

    +

    removeCluster(model: ClusterModel): Promise‹void›

    +

    Defined in src/extensions/stores/cluster-store.ts:102

    +

    Remove a cluster from store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModelcluster
    +

    Returns: Promise‹void›

    +
    +

    Static getInstance#

    +

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    +

    Inherited from ExtensionStore.getInstance

    +

    Defined in src/common/utils/singleton.ts:15

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

    Defined in src/common/utils/singleton.ts:23

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/v4.2.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html new file mode 100644 index 0000000000..50eefba6bb --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ExtensionStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: ExtensionStore ‹T#

    +

    Type parameters#

    +

    T

    +

    Hierarchy#

    +
      +
    • BaseStore‹T›
    • +
    +

    ExtensionStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    Protected constructor#

    +

    + new ExtensionStore(params: BaseStoreParams): ExtensionStore

    +

    Inherited from ExtensionStore.constructor

    +

    Defined in src/common/base-store.ts:26

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsBaseStoreParams
    +

    Returns: ExtensionStore

    +

    Properties#

    +

    Protected extension#

    +

    extension: LensExtension

    +

    Defined in src/extensions/extension-store.ts:6

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from ExtensionStore.isLoaded

    +

    Defined in src/common/base-store.ts:26

    +
    +

    Protected params#

    +

    params: BaseStoreParams

    +

    Inherited from ExtensionStore.params

    +

    Defined in src/common/base-store.ts:28

    +
    +

    Protected Optional storeConfig#

    +

    storeConfig? : Config‹T›

    +

    Inherited from ExtensionStore.storeConfig

    +

    Defined in src/common/base-store.ts:22

    +
    +

    Protected syncDisposers#

    +

    syncDisposers: Function[] = []

    +

    Inherited from ExtensionStore.syncDisposers

    +

    Defined in src/common/base-store.ts:23

    +
    +

    whenLoaded#

    +

    whenLoaded: Promise‹void› & object = when(() => this.isLoaded)

    +

    Inherited from ExtensionStore.whenLoaded

    +

    Defined in src/common/base-store.ts:25

    +

    Accessors#

    +

    name#

    +

    get name(): string

    +

    Inherited from ExtensionStore.name

    +

    Defined in src/common/base-store.ts:38

    +

    Returns: string

    +
    +

    path#

    +

    get path(): string

    +

    Inherited from ExtensionStore.path

    +

    Defined in src/common/base-store.ts:50

    +

    Returns: string

    +
    +

    Protected syncMainChannel#

    +

    get syncMainChannel(): string

    +

    Inherited from ExtensionStore.syncMainChannel

    +

    Defined in src/common/base-store.ts:46

    +

    Returns: string

    +
    +

    Protected syncRendererChannel#

    +

    get syncRendererChannel(): string

    +

    Inherited from ExtensionStore.syncRendererChannel

    +

    Defined in src/common/base-store.ts:42

    +

    Returns: string

    +

    Methods#

    +

    Protected applyWithoutSync#

    +

    applyWithoutSync(callback: function): void

    +

    Inherited from ExtensionStore.applyWithoutSync

    +

    Defined in src/common/base-store.ts:136

    +

    Parameters:

    +

    callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Protected cwd#

    +

    cwd(): string

    +

    Overrides void

    +

    Defined in src/extensions/extension-store.ts:20

    +

    Returns: string

    +
    +

    disableSync#

    +

    disableSync(): void

    +

    Inherited from ExtensionStore.disableSync

    +

    Defined in src/common/base-store.ts:131

    +

    Returns: void

    +
    +

    enableSync#

    +

    enableSync(): void

    +

    Inherited from ExtensionStore.enableSync

    +

    Defined in src/common/base-store.ts:94

    +

    Returns: void

    +
    +

    Protected Abstract fromStore#

    +

    fromStore(data: T): void

    +

    Inherited from ExtensionStore.fromStore

    +

    Defined in src/common/base-store.ts:166

    +

    fromStore is called internally when a child class syncs with the file +system.

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    dataTthe parsed information read from the stored JSON file
    +

    Returns: void

    +
    +

    Protected init#

    +

    init(): Promise‹void›

    +

    Inherited from ExtensionStore.init

    +

    Defined in src/common/base-store.ts:54

    +

    Returns: Promise‹void›

    +
    +

    load#

    +

    load(): Promise‹void›

    +

    Overrides void

    +

    Defined in src/extensions/extension-store.ts:14

    +

    Returns: Promise‹void›

    +
    +

    loadExtension#

    +

    loadExtension(extension: LensExtension): Promise‹void›

    +

    Defined in src/extensions/extension-store.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    extensionLensExtension
    +

    Returns: Promise‹void›

    +
    +

    Protected onModelChange#

    +

    onModelChange(model: T): Promise‹void›

    +

    Inherited from ExtensionStore.onModelChange

    +

    Defined in src/common/base-store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: Promise‹void›

    +
    +

    Protected onSync#

    +

    onSync(model: T): void

    +

    Inherited from ExtensionStore.onSync

    +

    Defined in src/common/base-store.ts:145

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: void

    +
    +

    Protected onSyncFromMain#

    +

    onSyncFromMain(model: T): void

    +

    Inherited from ExtensionStore.onSyncFromMain

    +

    Defined in src/common/base-store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: void

    +
    +

    Protected saveToFile#

    +

    saveToFile(model: T): Promise‹void›

    +

    Inherited from ExtensionStore.saveToFile

    +

    Defined in src/common/base-store.ts:83

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: Promise‹void›

    +
    +

    Abstract toJSON#

    +

    toJSON(): T

    +

    Inherited from ExtensionStore.toJSON

    +

    Defined in src/common/base-store.ts:175

    +

    toJSON is called when syncing the store to the filesystem. It should +produce a JSON serializable object representaion 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

    +
    +

    unregisterIpcListener#

    +

    unregisterIpcListener(): void

    +

    Inherited from ExtensionStore.unregisterIpcListener

    +

    Defined in src/common/base-store.ts:126

    +

    Returns: void

    +
    +

    Static getInstance#

    +

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    +

    Inherited from ExtensionStore.getInstance

    +

    Defined in src/common/utils/singleton.ts:15

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

    Defined in src/common/utils/singleton.ts:23

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_stores_.workspace/index.html b/v4.2.1/extensions/api/classes/_core_api_stores_.workspace/index.html new file mode 100644 index 0000000000..a4891fd303 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -0,0 +1,1297 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Workspace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Workspace#

    +

    Workspace

    +

    beta

    +

    Hierarchy#

    +
      +
    • Workspace
    • +
    +

    Implements#

    + +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Workspace(data: WorkspaceModel): Workspace

    +

    Defined in src/common/workspace-store.ts:72

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataWorkspaceModel
    +

    Returns: Workspace

    +

    Properties#

    +

    [updateFromModel]#

    +

    [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { + Object.assign(this, model); + })

    +

    Defined in src/common/workspace-store.ts:135

    +
    +

    Optional description#

    +

    description? : string

    +

    Implementation of WorkspaceModel.description

    +

    Defined in src/common/workspace-store.ts:54

    +

    Workspace description

    +

    observable

    +
    +

    id#

    +

    id: WorkspaceId

    +

    Implementation of WorkspaceModel.id

    +

    Defined in src/common/workspace-store.ts:42

    +

    Unique id for workspace

    +

    observable

    +
    +

    Optional lastActiveClusterId#

    +

    lastActiveClusterId? : ClusterId

    +

    Implementation of WorkspaceModel.lastActiveClusterId

    +

    Defined in src/common/workspace-store.ts:69

    +

    Last active cluster id

    +

    observable

    +
    +

    name#

    +

    name: string

    +

    Implementation of WorkspaceModel.name

    +

    Defined in src/common/workspace-store.ts:48

    +

    Workspace name

    +

    observable

    +
    +

    Optional ownerRef#

    +

    ownerRef? : string

    +

    Implementation of WorkspaceModel.ownerRef

    +

    Defined in src/common/workspace-store.ts:62

    +

    Workspace owner reference

    +

    If extension sets ownerRef then it needs to explicitly mark workspace as enabled onActivate (or when workspace is saved)

    +

    observable

    +

    Accessors#

    +

    enabled#

    +

    get enabled(): boolean

    +

    Defined in src/common/workspace-store.ts:91

    +

    Is workspace enabled

    +

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    +

    observable

    +

    Returns: boolean

    +

    set enabled(enabled: boolean): void

    +

    Defined in src/common/workspace-store.ts:95

    +

    Is workspace enabled

    +

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enabledboolean
    +

    Returns: void

    +
    +

    isManaged#

    +

    get isManaged(): boolean

    +

    Defined in src/common/workspace-store.ts:102

    +

    Is workspace managed by an extension

    +

    Returns: boolean

    +

    Methods#

    +

    getState#

    +

    getState(): WorkspaceState

    +

    Defined in src/common/workspace-store.ts:110

    +

    Get workspace state

    +

    Returns: WorkspaceState

    +
    +

    pushState#

    +

    pushState(state: WorkspaceState): void

    +

    Defined in src/common/workspace-store.ts:122

    +

    Push state

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    stateWorkspaceStatethis.getState()workspace state
    +

    Returns: void

    +
    +

    setState#

    +

    setState(state: WorkspaceState): void

    +

    Defined in src/common/workspace-store.ts:131

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateWorkspaceStateworkspace state
    +

    Returns: void

    +
    +

    toJSON#

    +

    toJSON(): WorkspaceModel

    +

    Defined in src/common/workspace-store.ts:139

    +

    Returns: WorkspaceModel

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/v4.2.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html new file mode 100644 index 0000000000..5a9d8ecdf5 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -0,0 +1,1370 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WorkspaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: WorkspaceStore#

    +

    Stores all workspaces

    +

    beta

    +

    Hierarchy#

    + +

    WorkspaceStore

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Properties#

    +

    Static defaultId#

    +

    defaultId: WorkspaceId = InternalWorkspaceStore.defaultId

    +

    Defined in src/extensions/stores/workspace-store.ts:17

    +

    Default workspace id, this workspace is always present

    +

    Accessors#

    +

    currentWorkspace#

    +

    get currentWorkspace(): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:43

    +

    Currently active workspace

    +

    Returns: Workspace

    +
    +

    currentWorkspaceId#

    +

    get currentWorkspaceId(): string

    +

    Defined in src/extensions/stores/workspace-store.ts:22

    +

    Currently active workspace id

    +

    Returns: string

    +

    set currentWorkspaceId(id: string): void

    +

    Defined in src/extensions/stores/workspace-store.ts:29

    +

    Set active workspace id

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: void

    +
    +

    enabledWorkspacesList#

    +

    get enabledWorkspacesList(): Workspace[]

    +

    Defined in src/extensions/stores/workspace-store.ts:57

    +

    Array of all enabled (visible) workspaces

    +

    Returns: Workspace[]

    +
    +

    workspaces#

    +

    get workspaces(): ObservableMap‹string, Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:36

    +

    Map of all workspaces

    +

    Returns: ObservableMap‹string, Workspace

    +
    +

    workspacesList#

    +

    get workspacesList(): Workspace[]

    +

    Defined in src/extensions/stores/workspace-store.ts:50

    +

    Array of all workspaces

    +

    Returns: Workspace[]

    +

    Methods#

    +

    addWorkspace#

    +

    addWorkspace(workspace: Workspace): Workspace‹›

    +

    Defined in src/extensions/stores/workspace-store.ts:89

    +

    Add a workspace to store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: Workspace‹›

    +
    +

    getById#

    +

    getById(id: WorkspaceId): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:65

    +

    Get workspace by id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    idWorkspaceIdworkspace id
    +

    Returns: Workspace

    +
    +

    getByName#

    +

    getByName(name: string): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:73

    +

    Get workspace by name

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    namestringworkspace name
    +

    Returns: Workspace

    +
    +

    removeWorkspace#

    +

    removeWorkspace(workspace: Workspace): void

    +

    Defined in src/extensions/stores/workspace-store.ts:105

    +

    Remove workspace from store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: void

    +
    +

    removeWorkspaceById#

    +

    removeWorkspaceById(id: WorkspaceId): void

    +

    Defined in src/extensions/stores/workspace-store.ts:113

    +

    Remove workspace by id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    idWorkspaceIdworkspace
    +

    Returns: void

    +
    +

    setActive#

    +

    setActive(id: string): void

    +

    Defined in src/extensions/stores/workspace-store.ts:81

    +

    Set active workspace

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    idstringWorkspaceStore.defaultIdworkspace id
    +

    Returns: void

    +
    +

    updateWorkspace#

    +

    updateWorkspace(workspace: Workspace): void

    +

    Defined in src/extensions/stores/workspace-store.ts:97

    +

    Update a workspace in store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: void

    +
    +

    Static getInstance#

    +

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    +

    Inherited from ExtensionStore.getInstance

    +

    Defined in src/common/utils/singleton.ts:15

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

    Defined in src/common/utils/singleton.ts:23

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_core_api_utils_.singleton/index.html b/v4.2.1/extensions/api/classes/_core_api_utils_.singleton/index.html new file mode 100644 index 0000000000..6b2aaaa475 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Singleton - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Singleton#

    +

    Hierarchy#

    +
      +
    • Singleton
    • +
    +

    ClusterStore

    +

    WorkspaceStore

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Static getInstance#

    +

    getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

    +

    Defined in src/common/utils/singleton.ts:15

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Defined in src/common/utils/singleton.ts:23

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.badge/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.badge/index.html new file mode 100644 index 0000000000..d5242cea84 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Badge ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Badge ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Badge

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Badge(props: Readonly‹BadgeProps› | BadgeProps): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹BadgeProps› | BadgeProps
    +

    Returns: Badge

    +

    + new Badge(props: BadgeProps, context: any): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsBadgeProps
    contextany
    +

    Returns: Badge

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹BadgeProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹BadgeProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹BadgeProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/badge/badge.tsx:15

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.button/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.button/index.html new file mode 100644 index 0000000000..84d39c87c0 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.button/index.html @@ -0,0 +1,1381 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Button ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Button ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Button

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ButtonProps
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ButtonProps
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/button/button.tsx:27

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html new file mode 100644 index 0000000000..3944ac2626 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -0,0 +1,1423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Checkbox ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Checkbox ‹S, SS#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    Hierarchy#

    + +

    Checkbox

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CheckboxProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CheckboxProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getValue#

    +

    getValue(): boolean

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:25

    +

    Returns: boolean

    +
    +

    onChange#

    +

    onChange(evt: ChangeEvent‹HTMLInputElement›): void

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtChangeEvent‹HTMLInputElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:31

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html new file mode 100644 index 0000000000..ff5a55520a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html @@ -0,0 +1,996 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CommandOverlay - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html new file mode 100644 index 0000000000..89d7ed461b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -0,0 +1,1850 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfirmDialog ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfirmDialog ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    ConfirmDialog

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfirmDialog(props: Readonly‹ConfirmDialogProps› | ConfirmDialogProps): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹ConfirmDialogProps› | ConfirmDialogProps
    +

    Returns: ConfirmDialog

    +

    + new ConfirmDialog(props: ConfirmDialogProps, context: any): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsConfirmDialogProps
    contextany
    +

    Returns: ConfirmDialog

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    isSaving#

    +

    isSaving: boolean = false

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:29

    +
    +

    props#

    +

    props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static isOpen#

    +

    isOpen: boolean = false

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:26

    +
    +

    Static params#

    +

    params: ConfirmDialogParams

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

    +

    Accessors#

    +

    params#

    +

    get params(): ConfirmDialogParams

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

    +

    Returns: ConfirmDialogParams

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:65

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ConfirmDialogProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ConfirmDialogProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    ok#

    +

    ok(): Promise‹void›

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:51

    +

    Returns: Promise‹void›

    +
    +

    onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    Static close#

    +

    close(): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:36

    +

    Returns: void

    +
    +

    Static open#

    +

    open(params: ConfirmDialogParams): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsConfirmDialogParams
    +

    Returns: void

    +

    Object literals#

    +

    defaultParams#

    +

    defaultParams: object#

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

    +

    icon#

    +

    icon: Element‹› =

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

    +

    labelCancel#

    +

    labelCancel: string = "Cancel"

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

    +

    labelOk#

    +

    labelOk: string = "Ok"

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

    +

    ok#

    +

    ok: any = noop

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html new file mode 100644 index 0000000000..67a7338bea --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CubeSpinner ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: CubeSpinner ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    CubeSpinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CubeSpinner(props: Readonly‹CubeSpinnerProps› | CubeSpinnerProps): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹CubeSpinnerProps› | CubeSpinnerProps
    +

    Returns: CubeSpinner

    +

    + new CubeSpinner(props: CubeSpinnerProps, context: any): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsCubeSpinnerProps
    contextany
    +

    Returns: CubeSpinner

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹CubeSpinnerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CubeSpinnerProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CubeSpinnerProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/spinner/cube-spinner.tsx:11

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.dialog/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.dialog/index.html new file mode 100644 index 0000000000..415c162d01 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Dialog ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Dialog ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Dialog

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Properties#

    +

    closeOnNavigate#

    +

    closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

    +

    Defined in src/renderer/components/dialog/dialog.tsx:45

    +

    Accessors#

    +

    elem#

    +

    get elem(): HTMLElement

    +

    Defined in src/renderer/components/dialog/dialog.tsx:51

    +

    Returns: HTMLElement

    +
    +

    isOpen#

    +

    get isOpen(): boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:56

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:87

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/dialog/dialog.tsx:60

    +

    Returns: void

    +
    +

    componentDidUpdate#

    +

    componentDidUpdate(prevProps: DialogProps): void

    +

    Overrides PageLayout.componentDidUpdate

    +

    Defined in src/renderer/components/dialog/dialog.tsx:64

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    prevPropsDialogProps
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/dialog/dialog.tsx:72

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹DialogProps›, prevState: Readonly‹DialogState›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DialogProps
    prevStateReadonly‹DialogState›
    +

    Returns: SS | null

    +
    +

    onClickOutside#

    +

    onClickOutside(evt: MouseEvent): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:121

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:103

    +

    Returns: void

    +
    +

    onEscapeKey#

    +

    onEscapeKey(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:112

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onOpen#

    +

    onOpen(): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:93

    +

    Returns: void

    +
    +

    open#

    +

    open(): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:81

    +

    Returns: void

    +
    +

    render#

    +

    render(): ReactPortal‹›

    +

    Defined in src/renderer/components/dialog/dialog.tsx:130

    +

    Returns: ReactPortal‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    toggle(isOpen: boolean): void

    +

    Defined in src/renderer/components/dialog/dialog.tsx:76

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    isOpenboolean
    +

    Returns: void

    +

    Object literals#

    +

    state#

    +

    state: object#

    +

    Defined in src/renderer/components/dialog/dialog.tsx:47

    +

    isOpen#

    +

    isOpen: boolean = this.props.isOpen

    +

    Defined in src/renderer/components/dialog/dialog.tsx:48

    +
    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/dialog/dialog.tsx:33

    +

    animated#

    +

    animated: true = true

    +

    Defined in src/renderer/components/dialog/dialog.tsx:40

    +

    close#

    +

    close: any = noop

    +

    Defined in src/renderer/components/dialog/dialog.tsx:36

    +

    isOpen#

    +

    isOpen: false = false

    +

    Defined in src/renderer/components/dialog/dialog.tsx:34

    + +

    modal: true = true

    +

    Defined in src/renderer/components/dialog/dialog.tsx:39

    +

    onClose#

    +

    onClose: any = noop

    +

    Defined in src/renderer/components/dialog/dialog.tsx:38

    +

    onOpen#

    +

    onOpen: any = noop

    +

    Defined in src/renderer/components/dialog/dialog.tsx:37

    +

    open#

    +

    open: any = noop

    +

    Defined in src/renderer/components/dialog/dialog.tsx:35

    +

    pinned#

    +

    pinned: false = false

    +

    Defined in src/renderer/components/dialog/dialog.tsx:41

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.drawer/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawer/index.html new file mode 100644 index 0000000000..85305fb5b1 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -0,0 +1,1748 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Drawer ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Drawer ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Drawer

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Drawer(props: Readonly‹DrawerProps› | DrawerProps): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerProps› | DrawerProps
    +

    Returns: Drawer

    +

    + new Drawer(props: DrawerProps, context: any): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerProps
    contextany
    +

    Returns: Drawer

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹DrawerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/drawer/drawer.tsx:31

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:101

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/drawer/drawer.tsx:42

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹DrawerProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹DrawerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/drawer/drawer.tsx:49

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClickOutside#

    +

    onClickOutside(evt: MouseEvent): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:80

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onEscapeKey#

    +

    onEscapeKey(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onMouseDown#

    +

    onMouseDown(evt: MouseEvent): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:95

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:107

    +

    Returns: Element‹›

    +
    +

    restoreScrollPos#

    +

    restoreScrollPos(): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:63

    +

    Returns: void

    +
    +

    saveScrollPos#

    +

    saveScrollPos(): void

    +

    Defined in src/renderer/components/drawer/drawer.tsx:56

    +

    Returns: void

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html new file mode 100644 index 0000000000..f9b393636a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerItem ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    DrawerItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerItem(props: Readonly‹DrawerItemProps› | DrawerItemProps): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerItemProps› | DrawerItemProps
    +

    Returns: DrawerItem

    +

    + new DrawerItem(props: DrawerItemProps, context: any): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerItemProps
    contextany
    +

    Returns: DrawerItem

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹DrawerItemProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerItemProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerItemProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:15

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html new file mode 100644 index 0000000000..a307580296 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -0,0 +1,1627 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerParamToggler ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerParamToggler ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    DrawerParamToggler

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps
    +

    Returns: DrawerParamToggler

    +

    + new DrawerParamToggler(props: DrawerParamTogglerProps, context: any): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerParamTogglerProps
    contextany
    +

    Returns: DrawerParamToggler

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹DrawerParamTogglerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: State

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:14

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerParamTogglerProps
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerParamTogglerProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    toggle(): void

    +

    Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:16

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html new file mode 100644 index 0000000000..2d1e7986c8 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerTitle ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerTitle ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    DrawerTitle

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerTitle(props: Readonly‹DrawerTitleProps› | DrawerTitleProps): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerTitleProps› | DrawerTitleProps
    +

    Returns: DrawerTitle

    +

    + new DrawerTitle(props: DrawerTitleProps, context: any): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerTitleProps
    contextany
    +

    Returns: DrawerTitle

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹DrawerTitleProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerTitleProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerTitleProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/drawer/drawer-title.tsx:11

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.icon/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.icon/index.html new file mode 100644 index 0000000000..546d414174 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -0,0 +1,1526 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Icon ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Icon ‹S, SS#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    Hierarchy#

    + +

    Icon

    +

    Index#

    +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Accessors#

    +

    isInteractive#

    +

    get isInteractive(): boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:33

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹IconProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹IconProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    onClick(evt: MouseEvent): void

    +

    Defined in src/renderer/components/icon/icon.tsx:40

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent‹any›): void

    +

    Defined in src/renderer/components/icon/icon.tsx:51

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/icon/icon.tsx:70

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/icon/icon.tsx:29

    +

    focusable#

    +

    focusable: true = true

    +

    Defined in src/renderer/components/icon/icon.tsx:30

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.input/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.input/index.html new file mode 100644 index 0000000000..1d1de53a1d --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.input/index.html @@ -0,0 +1,2069 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Input ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Input ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Input

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Input(props: Readonly‹InputProps› | InputProps): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹InputProps› | InputProps
    +

    Returns: Input

    +

    + new Input(props: InputProps, context: any): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsInputProps
    contextany
    +

    Returns: Input

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    input#

    +

    input: InputElement

    +

    Defined in src/renderer/components/input/input.tsx:58

    +
    +

    props#

    +

    props: Readonly‹InputProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    validators#

    +

    validators: InputValidator[] = []

    +

    Defined in src/renderer/components/input/input.tsx:59

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/input/input.tsx:56

    +

    Accessors#

    +

    isUncontrolled#

    +

    get isUncontrolled(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:258

    +

    Returns: boolean

    +
    +

    showMaxLenIndicator#

    +

    get showMaxLenIndicator(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:252

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    bindRef#

    +

    bindRef(elem: InputElement): void

    +

    Defined in src/renderer/components/input/input.tsx:285

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemInputElement
    +

    Returns: void

    +
    +

    blur#

    +

    blur(): void

    +

    Defined in src/renderer/components/input/input.tsx:95

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/input/input.tsx:262

    +

    Returns: void

    +
    +

    componentDidUpdate#

    +

    componentDidUpdate(prevProps: InputProps): void

    +

    Overrides PageLayout.componentDidUpdate

    +

    Defined in src/renderer/components/input/input.tsx:267

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    prevPropsInputProps
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    focus#

    +

    focus(): void

    +

    Defined in src/renderer/components/input/input.tsx:91

    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹InputProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹InputProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    getValue#

    +

    getValue(): string

    +

    Defined in src/renderer/components/input/input.tsx:82

    +

    Returns: string

    +
    +

    isValid#

    +

    isValid(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:67

    +

    Returns: boolean

    +
    +

    onBlur#

    +

    onBlur(evt: FocusEvent‹InputElement›): void

    +

    Defined in src/renderer/components/input/input.tsx:208

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹InputElement›
    +

    Returns: void

    +
    +

    onChange#

    +

    onChange(evt: ChangeEvent‹any›): void

    +

    Defined in src/renderer/components/input/input.tsx:217

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtChangeEvent‹any›
    +

    Returns: void

    +
    +

    onFocus#

    +

    onFocus(evt: FocusEvent‹InputElement›): void

    +

    Defined in src/renderer/components/input/input.tsx:199

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹InputElement›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent‹any›): void

    +

    Defined in src/renderer/components/input/input.tsx:236

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/input/input.tsx:289

    +

    Returns: Element‹›

    +
    +

    select#

    +

    select(): void

    +

    Defined in src/renderer/components/input/input.tsx:99

    +

    Returns: void

    +
    +

    setDirty#

    +

    setDirty(dirty: boolean): void

    +

    Defined in src/renderer/components/input/input.tsx:193

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    dirtybooleantrue
    +

    Returns: void

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    setValidation#

    +

    setValidation(errors: React.ReactNode[]): void

    +

    Defined in src/renderer/components/input/input.tsx:163

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorsReact.ReactNode[]
    +

    Returns: void

    +
    +

    setValue#

    +

    setValue(value: string): void

    +

    Defined in src/renderer/components/input/input.tsx:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring
    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    validate#

    +

    validate(value: string): Promise‹void›

    +

    Defined in src/renderer/components/input/input.tsx:119

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valuestringthis.getValue()
    +

    Returns: Promise‹void›

    +

    Object literals#

    +

    state#

    +

    state: object#

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/input/input.tsx:61

    +

    dirty#

    +

    dirty: boolean = !!this.props.dirty

    +

    Defined in src/renderer/components/input/input.tsx:62

    +

    errors#

    +

    errors: undefined[] = []

    +

    Defined in src/renderer/components/input/input.tsx:64

    +

    valid#

    +

    valid: true = true

    +

    Defined in src/renderer/components/input/input.tsx:63

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html new file mode 100644 index 0000000000..ca8a940b8d --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -0,0 +1,1615 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEventDetails ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeEventDetails ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeEventDetails

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeEventDetails(props: Readonly‹KubeEventDetailsProps› | KubeEventDetailsProps): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeEventDetailsProps› | KubeEventDetailsProps
    +

    Returns: KubeEventDetails

    +

    + new KubeEventDetails(props: KubeEventDetailsProps, context: any): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeEventDetailsProps
    contextany
    +

    Returns: KubeEventDetails

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹KubeEventDetailsProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeEventDetailsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): Promise‹void›

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/+events/kube-event-details.tsx:16

    +

    Returns: Promise‹void›

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹KubeEventDetailsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeEventDetailsProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹KubeEventDetailsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹KubeEventDetailsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeEventDetailsProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+events/kube-event-details.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html new file mode 100644 index 0000000000..eff85db05d --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectDetails ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectDetails ‹P, S, SS, P, S#

    +

    Type parameters#

    +

    P

    +

    S

    +

    SS

    +

    P

    +

    S

    +

    Hierarchy#

    +
      +
    • Component
    • +
    +

    KubeObjectDetails

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectDetails(props: Readonly‹P› | P): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P› | P
    +

    Returns: KubeObjectDetails

    +

    + new KubeObjectDetails(props: P, context: any): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    contextany
    +

    Returns: KubeObjectDetails

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:70

    +
    +

    loader#

    +

    loader: IReactionDisposer = reaction(() => [ + this.path, + this.object, // resource might be updated via watch-event or from already opened details + crdStore.items.length, // crd stores initialized after loading + ], async () => { + this.loadingError = ""; + const { path, object } = this;

    +
    if (!object) {
    +  const store = apiManager.getStore(path);
    +
    +  if (store) {
    +    this.isLoading = true;
    +
    +    try {
    +      await store.loadFromPath(path);
    +    } catch (err) {
    +      this.loadingError = <>Resource loading has failed: <b>{err.toString()}</b>;
    +    } finally {
    +      this.isLoading = false;
    +    }
    +  }
    +}
    +
    +

    })

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:90

    +
    +

    loadingError#

    +

    loadingError: React.ReactNode

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:71

    +
    +

    props#

    +

    props: Readonly‹P› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    isCrdInstance#

    +

    get isCrdInstance(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:85

    +

    Returns: boolean

    +
    +

    object#

    +

    get object(): any

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:77

    +

    Returns: any

    +
    +

    path#

    +

    get path(): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:73

    +

    Returns: string

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:115

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html new file mode 100644 index 0000000000..409a0f09fc --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -0,0 +1,1679 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectListLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectListLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectListLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectListLayout(props: Readonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps
    +

    Returns: KubeObjectListLayout

    +

    + new KubeObjectListLayout(props: KubeObjectListLayoutProps, context: any): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectListLayoutProps
    contextany
    +

    Returns: KubeObjectListLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹KubeObjectListLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    selectedItem#

    +

    get selectedItem(): any

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:20

    +

    Returns: any

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectListLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:24

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹KubeObjectListLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectListLayoutProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectListLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectListLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectListLayoutProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onDetails#

    +

    onDetails(item: KubeObject): void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeObject
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:44

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html new file mode 100644 index 0000000000..b8623ad3ee --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -0,0 +1,1717 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMenu ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectMenu ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectMenu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMenu(props: Readonly‹KubeObjectMenuProps› | KubeObjectMenuProps): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMenuProps› | KubeObjectMenuProps
    +

    Returns: KubeObjectMenu

    +

    + new KubeObjectMenu(props: KubeObjectMenuProps, context: any): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMenuProps
    contextany
    +

    Returns: KubeObjectMenu

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹KubeObjectMenuProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    isEditable#

    +

    get isEditable(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:25

    +

    Returns: boolean

    +
    +

    isRemovable#

    +

    get isRemovable(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

    +

    Returns: boolean

    +
    +

    store#

    +

    get store(): KubeObjectStore‹any›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

    +

    Returns: KubeObjectStore‹any›

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectMenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹KubeObjectMenuProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMenuProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectMenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectMenuProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMenuProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    remove#

    +

    remove(): Promise‹void›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:44

    +

    Returns: Promise‹void›

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

    +

    Returns: Element‹›

    +
    +

    renderRemoveMessage#

    +

    renderRemoveMessage(): Element‹›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    update#

    +

    update(): Promise‹void›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:38

    +

    Returns: Promise‹void›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html new file mode 100644 index 0000000000..298086bb05 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -0,0 +1,1658 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMeta ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectMeta ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectMeta

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps› | KubeObjectMetaProps): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMetaProps› | KubeObjectMetaProps
    +

    Returns: KubeObjectMeta

    +

    + new KubeObjectMeta(props: KubeObjectMetaProps, context: any): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMetaProps
    contextany
    +

    Returns: KubeObjectMeta

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹KubeObjectMetaProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultHiddenFields#

    +

    defaultHiddenFields: IKubeMetaField[] = [ + "uid", "resourceVersion", "selfLink" + ]

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:15

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMetaProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMetaProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    isHidden#

    +

    isHidden(field: IKubeMetaField): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    fieldIKubeMetaField
    +

    Returns: boolean

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html new file mode 100644 index 0000000000..89fa3a798f --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -0,0 +1,1464 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LineProgress ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: LineProgress ‹S, SS#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    Hierarchy#

    + +

    LineProgress

    +

    Index#

    +

    Methods#

    + +

    Object literals#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹LineProgressProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹LineProgressProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    +

    max#

    +

    max: number = 100

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    +

    min#

    +

    min: number = 0

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    +

    precise#

    +

    precise: number = 2

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    +

    value#

    +

    value: number = 0

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.menu/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.menu/index.html new file mode 100644 index 0000000000..50981f53af --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -0,0 +1,2024 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Menu ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Menu ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Menu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Menu(props: Readonly‹MenuProps› | MenuProps): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuProps› | MenuProps
    +

    Returns: Menu

    +

    + new Menu(props: MenuProps, context: any): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuProps
    contextany
    +

    Returns: Menu

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    elem#

    +

    elem: HTMLUListElement

    +

    Defined in src/renderer/components/menu/menu.tsx:56

    +
    +

    Protected items#

    +

    items: object

    +

    Defined in src/renderer/components/menu/menu.tsx:57

    +

    Type declaration:#

    + +
    +

    opener#

    +

    opener: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:55

    +
    +

    props#

    +

    props: Readonly‹MenuProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refreshPosition#

    +

    refreshPosition: (Anonymous function) & Cancelable = debounce(() => { + if (!this.props.usePortal || !this.opener) return; + const { width, height } = this.opener.getBoundingClientRect(); + let { left, top, bottom, right } = this.opener.getBoundingClientRect(); + const withScroll = window.getComputedStyle(this.elem).position !== "fixed";

    +
    // window global scroll corrections
    +if (withScroll) {
    +  left += window.pageXOffset;
    +  top += window.pageYOffset;
    +  right = left + width;
    +  bottom = top + height;
    +}
    +
    +// setup initial position
    +const position: MenuPosition = { left: true, bottom: true };
    +
    +this.elem.style.left = `${left}px`;
    +this.elem.style.top = `${bottom}px`;
    +
    +// correct position if menu doesn't fit to viewport
    +const menuPos = this.elem.getBoundingClientRect();
    +
    +if (menuPos.right > window.innerWidth) {
    +  this.elem.style.left = `${right - this.elem.offsetWidth}px`;
    +  position.right = true;
    +  delete position.left;
    +}
    +
    +if (menuPos.bottom > window.innerHeight) {
    +  this.elem.style.top = `${top - this.elem.offsetHeight}px`;
    +  position.top = true;
    +  delete position.bottom;
    +}
    +this.setState({ position });
    +
    +

    }, Animate.VISIBILITY_DELAY_MS)

    +

    Defined in src/renderer/components/menu/menu.tsx:125

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: State

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/menu/menu.tsx:59

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultPropsMenu as object

    +

    Defined in src/renderer/components/menu/menu.tsx:53

    +

    Accessors#

    +

    Protected focusableItems#

    +

    get focusableItems(): MenuItem‹›[]

    +

    Defined in src/renderer/components/menu/menu.tsx:99

    +

    Returns: MenuItem‹›[]

    +
    +

    Protected focusedItem#

    +

    get focusedItem(): MenuItem‹›

    +

    Defined in src/renderer/components/menu/menu.tsx:103

    +

    Returns: MenuItem‹›

    +
    +

    isOpen#

    +

    get isOpen(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:61

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindItemRef#

    +

    bindItemRef(item: MenuItem, index: number): void

    +

    Defined in src/renderer/components/menu/menu.tsx:246

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemMenuItem
    indexnumber
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    bindRef(elem: HTMLUListElement): void

    +

    Defined in src/renderer/components/menu/menu.tsx:242

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLUListElement
    +

    Returns: void

    +
    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:169

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/menu/menu.tsx:65

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹MenuProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuProps
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹MenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/menu/menu.tsx:88

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Protected focusNextItem#

    +

    focusNextItem(reverse: boolean): void

    +

    Defined in src/renderer/components/menu/menu.tsx:107

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    reversebooleanfalse
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹MenuProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    onBlur#

    +

    onBlur(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:236

    +

    Returns: void

    +
    +

    onClickOutside#

    +

    onClickOutside(evt: MouseEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:224

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onContextMenu#

    +

    onContextMenu(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:205

    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:178

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onScrollOutside#

    +

    onScrollOutside(evt: UIEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:214

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtUIEvent
    +

    Returns: void

    +
    +

    onWindowResize#

    +

    onWindowResize(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:209

    +

    Returns: void

    +
    +

    open#

    +

    open(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:162

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:250

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    toggle(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:174

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html new file mode 100644 index 0000000000..b1c4aad7be --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -0,0 +1,1731 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuActions ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: MenuActions ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    MenuActions

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new MenuActions(props: Readonly‹MenuActionsProps› | MenuActionsProps): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuActionsProps› | MenuActionsProps
    +

    Returns: MenuActions

    +

    + new MenuActions(props: MenuActionsProps, context: any): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuActionsProps
    contextany
    +

    Returns: MenuActions

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    id#

    +

    id: string = uniqueId("menu_actions_")

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:31

    +
    +

    isOpen#

    +

    isOpen: boolean = !!this.props.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:33

    +
    +

    props#

    +

    props: Readonly‹MenuActionsProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuActionsProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuActionsProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    remove#

    +

    remove(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:41

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:82

    +

    Returns: Element‹›

    +
    +

    renderTriggerIcon#

    +

    renderTriggerIcon(): Element‹›

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:55

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    toggle(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:35

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:25

    +

    removeConfirmationMessage#

    +

    removeConfirmationMessage:

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html new file mode 100644 index 0000000000..02ccf1dfa6 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: MenuItem ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    MenuItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new MenuItem(props: Readonly‹MenuItemProps› | MenuItemProps): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuItemProps› | MenuItemProps
    +

    Returns: MenuItem

    +

    + new MenuItem(props: MenuItemProps, context: any): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuItemProps
    contextany
    +

    Returns: MenuItem

    +

    Properties#

    +

    context#

    +

    context: MenuContextValue

    +

    Overrides PageLayout.context

    +

    Defined in src/renderer/components/menu/menu.tsx:321

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:322

    +
    +

    props#

    +

    props: Readonly‹MenuItemProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static contextType#

    +

    contextType: Context‹Menu‹›› = MenuContext

    +

    Overrides PageLayout.contextType

    +

    Defined in src/renderer/components/menu/menu.tsx:319

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultPropsMenuItem as object

    +

    Defined in src/renderer/components/menu/menu.tsx:318

    +

    Accessors#

    +

    isFocusable#

    +

    get isFocusable(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:324

    +

    Returns: boolean

    +
    + +

    get isLink(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:330

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/menu/menu.tsx:346

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuItemProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuItemProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    onClick(evt: MouseEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:334

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:350

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html new file mode 100644 index 0000000000..73075bd8ea --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceSelect ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: NamespaceSelect ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    NamespaceSelect

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceSelect(props: Readonly‹Props› | Props): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: NamespaceSelect

    +

    + new NamespaceSelect(props: Props, context: any): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: NamespaceSelect

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:37

    +

    Accessors#

    +

    options#

    +

    get options(): SelectOption[]

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:48

    +

    Returns: SelectOption[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:39

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    formatOptionLabel#

    +

    formatOptionLabel(option: SelectOption): object

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:65

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionSelectOption
    +

    Returns: object

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:77

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.notifications/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.notifications/index.html new file mode 100644 index 0000000000..2fac799248 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -0,0 +1,1769 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Notifications ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Notifications ‹P, S, SS, P, S#

    +

    Type parameters#

    +

    P

    +

    S

    +

    SS

    +

    P

    +

    S

    +

    Hierarchy#

    +
      +
    • Component
    • +
    +

    Notifications

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Notifications(props: Readonly‹P› | P): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P› | P
    +

    Returns: Notifications

    +

    + new Notifications(props: P, context: any): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    contextany
    +

    Returns: Notifications

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/notifications/notifications.tsx:14

    +
    +

    props#

    +

    props: Readonly‹P› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/notifications/notifications.tsx:42

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    getMessage#

    +

    getMessage(notification: Notification): (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    +

    Defined in src/renderer/components/notifications/notifications.tsx:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    notificationNotification
    +

    Returns: (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:70

    +

    Returns: Element‹›

    +
    +

    scrollToLastNotification#

    +

    scrollToLastNotification(): void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:50

    +

    Returns: void

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    Static error#

    +

    error(message: NotificationMessage, customOpts: Partial‹Notification›): void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:24

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    messageNotificationMessage-
    customOptsPartial‹Notification{}
    +

    Returns: void

    +
    +

    Static info#

    +

    info(message: NotificationMessage, customOpts: Partial‹Notification›): function

    +

    Defined in src/renderer/components/notifications/notifications.tsx:33

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    messageNotificationMessage-
    customOptsPartial‹Notification{}
    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static ok#

    +

    ok(message: NotificationMessage): void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:16

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    messageNotificationMessage
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html new file mode 100644 index 0000000000..5fc7370ec1 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -0,0 +1,1143 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NotificationsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NotificationsStore#

    +

    Hierarchy#

    +
      +
    • NotificationsStore
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Protected autoHideTimers#

    +

    autoHideTimers: Map‹string | number, number› = new Map()

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:28

    +
    +

    notifications#

    +

    notifications: IObservableArray‹Notification = observable.array([], { deep: false })

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:26

    +

    Methods#

    +

    add#

    +

    add(notification: Notification): function

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:55

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    notificationNotification
    +

    Returns: function

    +

    ▸ (): void

    +
    +

    addAutoHideTimer#

    +

    addAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:34

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    getById#

    +

    getById(id: NotificationId): Notification | null

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:30

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: Notification | null

    +
    +

    remove#

    +

    remove(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:72

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    removeAutoHideTimer#

    +

    removeAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:47

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html new file mode 100644 index 0000000000..d5578ba19b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PageLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PageLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    PageLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PageLayout(props: Readonly‹PageLayoutProps› | PageLayoutProps): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹PageLayoutProps› | PageLayoutProps
    +

    Returns: PageLayout

    +

    + new PageLayout(props: PageLayoutProps, context: any): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsPageLayoutProps
    contextany
    +

    Returns: PageLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹PageLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/layout/page-layout.tsx:29

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹PageLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    back#

    +

    back(evt?: MouseEvent | KeyboardEvent): void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:32

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evt?MouseEvent | KeyboardEvent
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): Promise‹void›

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/layout/page-layout.tsx:40

    +

    Returns: Promise‹void›

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹PageLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹PageLayoutProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹PageLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/layout/page-layout.tsx:44

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹PageLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹PageLayoutProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onEscapeKey#

    +

    onEscapeKey(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:48

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:59

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html new file mode 100644 index 0000000000..0236ed5bef --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDetailsList ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PodDetailsList ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    PodDetailsList

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDetailsList(props: Readonly‹Props› | Props): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: PodDetailsList

    +

    + new PodDetailsList(props: Props, context: any): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: PodDetailsList

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:53

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getTableRow#

    +

    getTableRow(uid: string): Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +

    Returns: Element‹›

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

    +

    Returns: Element‹›

    +
    +

    renderCpuUsage#

    +

    renderCpuUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    renderMemoryUsage#

    +

    renderMemoryUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

    +

    showTitle#

    +

    showTitle: true = true

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.radio/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.radio/index.html new file mode 100644 index 0000000000..903566181d --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -0,0 +1,1657 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Radio ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Radio ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Radio

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Radio(props: Readonly‹RadioProps› | RadioProps): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioProps› | RadioProps
    +

    Returns: Radio

    +

    + new Radio(props: RadioProps, context: any): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioProps
    contextany
    +

    Returns: Radio

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹RadioProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onChange#

    +

    onChange(): void

    +

    Defined in src/renderer/components/radio/radio.tsx:52

    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(e: KeyboardEvent‹any›): void

    +

    Defined in src/renderer/components/radio/radio.tsx:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/radio/radio.tsx:70

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html new file mode 100644 index 0000000000..dd847a5d19 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RadioGroup ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: RadioGroup ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    RadioGroup

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RadioGroup(props: Readonly‹RadioGroupProps› | RadioGroupProps): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioGroupProps› | RadioGroupProps
    +

    Returns: RadioGroup

    +

    + new RadioGroup(props: RadioGroupProps, context: any): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioGroupProps
    contextany
    +

    Returns: RadioGroup

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹RadioGroupProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioGroupProps
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioGroupProps
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/radio/radio.tsx:17

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof object

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.select/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.select/index.html new file mode 100644 index 0000000000..c2963f1e6f --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.select/index.html @@ -0,0 +1,1838 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Select ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Select ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Select

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Select(props: Readonly‹SelectProps› | SelectProps): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SelectProps› | SelectProps
    +

    Returns: Select

    +

    + new Select(props: SelectProps, context: any): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSelectProps
    contextany
    +

    Returns: Select

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹SelectProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    options#

    +

    get options(): SelectOption[]

    +

    Defined in src/renderer/components/select/select.tsx:71

    +

    Returns: SelectOption[]

    +
    +

    selectedOption#

    +

    get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

    +

    Defined in src/renderer/components/select/select.tsx:57

    +

    Returns: SelectOption‹any› | SelectOption‹any›[]

    +
    +

    theme#

    +

    get theme(): "dark" | "light" | "outlined"

    +

    Defined in src/renderer/components/select/select.tsx:42

    +

    Returns: "dark" | "light" | "outlined"

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SelectProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SelectProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    Protected isValidOption#

    +

    isValidOption(opt: SelectOption | any): boolean

    +

    Defined in src/renderer/components/select/select.tsx:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optSelectOption | any
    +

    Returns: boolean

    +
    +

    onChange#

    +

    onChange(value: SelectOption, meta: ActionMeta‹any›): void

    +

    Defined in src/renderer/components/select/select.tsx:84

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valueSelectOption
    metaActionMeta‹any›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/select/select.tsx:91

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/select/select.tsx:100

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/select/select.tsx:36

    +

    autoConvertOptions#

    +

    autoConvertOptions: true = true

    +

    Defined in src/renderer/components/select/select.tsx:37

    + +

    menuPlacement: "auto" = "auto"

    +

    Defined in src/renderer/components/select/select.tsx:39

    + +

    menuPortalTarget: HTMLElement = document.body

    +

    Defined in src/renderer/components/select/select.tsx:38

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.slider/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.slider/index.html new file mode 100644 index 0000000000..e16c3f63f8 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -0,0 +1,1628 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Slider ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Slider ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Slider

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Slider(props: Readonly‹SliderProps› | SliderProps): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SliderProps› | SliderProps
    +

    Returns: Slider

    +

    + new Slider(props: SliderProps, context: any): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSliderProps
    contextany
    +

    Returns: Slider

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹SliderProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/slider/slider.tsx:21

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SliderProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SliderProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/slider/slider.tsx:30

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.spinner/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.spinner/index.html new file mode 100644 index 0000000000..d96290de27 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -0,0 +1,1676 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Spinner ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Spinner ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Spinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Spinner(props: Readonly‹SpinnerProps› | SpinnerProps): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SpinnerProps› | SpinnerProps
    +

    Returns: Spinner

    +

    + new Spinner(props: SpinnerProps, context: any): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSpinnerProps
    contextany
    +

    Returns: Spinner

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹SpinnerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SpinnerProps
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SpinnerProps
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/spinner/spinner.tsx:18

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof object

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/spinner/spinner.tsx:13

    +

    center#

    +

    center: boolean = false

    +

    Defined in src/renderer/components/spinner/spinner.tsx:15

    +

    singleColor#

    +

    singleColor: boolean = true

    +

    Defined in src/renderer/components/spinner/spinner.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html new file mode 100644 index 0000000000..a584e145f7 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatusBrick ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: StatusBrick ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    StatusBrick

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatusBrick(props: Readonly‹StatusBrickProps› | StatusBrickProps): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StatusBrickProps› | StatusBrickProps
    +

    Returns: StatusBrick

    +

    + new StatusBrick(props: StatusBrickProps, context: any): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStatusBrickProps
    contextany
    +

    Returns: StatusBrick

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹StatusBrickProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StatusBrickProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StatusBrickProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.stepper/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.stepper/index.html new file mode 100644 index 0000000000..a578db7a18 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Stepper ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Stepper ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Stepper

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Stepper(props: Readonly‹StepperProps› | StepperProps): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StepperProps› | StepperProps
    +

    Returns: Stepper

    +

    + new Stepper(props: StepperProps, context: any): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStepperProps
    contextany
    +

    Returns: Stepper

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹StepperProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StepperProps
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StepperProps
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/stepper/stepper.tsx:15

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof object

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tab/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tab/index.html new file mode 100644 index 0000000000..c0c055fd07 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tab ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Tab ‹S, SS#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    Hierarchy#

    + +

    Tab

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Properties#

    +

    context#

    +

    context: TabsContextValue

    +

    Defined in src/renderer/components/tabs/tabs.tsx:65

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/tabs/tabs.tsx:66

    +
    +

    Static contextType#

    +

    contextType: Context‹TabsContextValue‹any›› = TabsContext

    +

    Defined in src/renderer/components/tabs/tabs.tsx:64

    +

    Accessors#

    +

    isActive#

    +

    get isActive(): boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:68

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:121

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/tabs/tabs.tsx:114

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    focus#

    +

    focus(): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:74

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    onClick(evt: MouseEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:86

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onFocus#

    +

    onFocus(evt: FocusEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:96

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:104

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/tabs/tabs.tsx:125

    +

    Returns: Element‹›

    +
    +

    scrollIntoView#

    +

    scrollIntoView(): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:78

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.table/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.table/index.html new file mode 100644 index 0000000000..424cb44519 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.table/index.html @@ -0,0 +1,1858 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Table ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Table ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Table

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Table(props: Readonly‹TableProps› | TableProps): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableProps› | TableProps
    +

    Returns: Table

    +

    + new Table(props: TableProps, context: any): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableProps
    contextany
    +

    Returns: Table

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹TableProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    sortParams#

    +

    get sortParams(): object

    +

    Defined in src/renderer/components/table/table.tsx:75

    +

    Returns: object

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/table/table.tsx:67

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getSorted#

    +

    getSorted(items: any[]): any[]

    +

    Defined in src/renderer/components/table/table.tsx:113

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsany[]
    +

    Returns: any[]

    +
    +

    Protected onSort#

    +

    onSort(__namedParameters: object): void

    +

    Defined in src/renderer/components/table/table.tsx:121

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    orderBystring
    sortBystring
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table.tsx:193

    +

    Returns: Element‹›

    +
    +

    renderHead#

    +

    renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

    +

    Defined in src/renderer/components/table/table.tsx:79

    +

    Returns: ReactElement‹TableHeadProps‹›, string | function | object›

    +
    +

    renderRows#

    +

    renderRows(): object

    +

    Defined in src/renderer/components/table/table.tsx:148

    +

    Returns: object

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    sort#

    +

    sort(colName: TableSortBy): void

    +

    Defined in src/renderer/components/table/table.tsx:136

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    colNameTableSortBy
    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/table/table.tsx:59

    +

    autoSize#

    +

    autoSize: true = true

    +

    Defined in src/renderer/components/table/table.tsx:61

    +

    rowLineHeight#

    +

    rowLineHeight: string = "17px"

    +

    Defined in src/renderer/components/table/table.tsx:63

    +

    rowPadding#

    +

    rowPadding: string = "8px"

    +

    Defined in src/renderer/components/table/table.tsx:62

    +

    scrollable#

    +

    scrollable: true = true

    +

    Defined in src/renderer/components/table/table.tsx:60

    +

    sortSyncWithUrl#

    +

    sortSyncWithUrl: true = true

    +

    Defined in src/renderer/components/table/table.tsx:64

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html new file mode 100644 index 0000000000..a24f2d73c4 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -0,0 +1,1706 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableCell ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: TableCell ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    TableCell

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableCell(props: Readonly‹TableCellProps› | TableCellProps): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableCellProps› | TableCellProps
    +

    Returns: TableCell

    +

    + new TableCell(props: TableCellProps, context: any): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableCellProps
    contextany
    +

    Returns: TableCell

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹TableCellProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    isSortable#

    +

    get isSortable(): boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:37

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableCellProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TableCellProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableCellProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TableCellProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TableCellProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableCellProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    onClick(evt: MouseEvent‹HTMLDivElement›): void

    +

    Defined in src/renderer/components/table/table-cell.tsx:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLDivElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-cell.tsx:67

    +

    Returns: Element‹›

    +
    +

    renderCheckbox#

    +

    renderCheckbox(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:58

    +

    Returns: Element‹›

    +
    +

    renderSortIcon#

    +

    renderSortIcon(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:43

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html new file mode 100644 index 0000000000..ac59412ee0 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -0,0 +1,1668 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableHead ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: TableHead ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    TableHead

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableHead(props: Readonly‹TableHeadProps› | TableHeadProps): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableHeadProps› | TableHeadProps
    +

    Returns: TableHead

    +

    + new TableHead(props: TableHeadProps, context: any): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableHeadProps
    contextany
    +

    Returns: TableHead

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹TableHeadProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableHeadProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableHeadProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-head.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/table/table-head.tsx:16

    +

    sticky#

    +

    sticky: true = true

    +

    Defined in src/renderer/components/table/table-head.tsx:17

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html new file mode 100644 index 0000000000..97820a17a8 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableRow ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: TableRow ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    TableRow

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableRow(props: Readonly‹TableRowProps› | TableRowProps): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableRowProps› | TableRowProps
    +

    Returns: TableRow

    +

    + new TableRow(props: TableRowProps, context: any): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableRowProps
    contextany
    +

    Returns: TableRow

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹TableRowProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableRowProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableRowProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-row.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tabs/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tabs/index.html new file mode 100644 index 0000000000..5460b8bc9c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -0,0 +1,1445 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tabs ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Tabs ‹S, SS#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    Hierarchy#

    + +

    Tabs

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/tabs/tabs.tsx:25

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:28

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabsProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabsProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/tabs/tabs.tsx:32

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html new file mode 100644 index 0000000000..bf95b8d071 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -0,0 +1,1860 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tooltip ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Tooltip ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Tooltip

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Tooltip(props: Readonly‹TooltipProps› | TooltipProps): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TooltipProps› | TooltipProps
    +

    Returns: Tooltip

    +

    + new Tooltip(props: TooltipProps, context: any): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTooltipProps
    contextany
    +

    Returns: Tooltip

    +

    Properties#

    +

    activePosition#

    +

    activePosition: TooltipPosition

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:51

    +
    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:50

    +
    +

    isVisible#

    +

    isVisible: boolean = !!this.props.visible

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:52

    +
    +

    props#

    +

    props: Readonly‹TooltipProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:48

    +

    Accessors#

    +

    hoverTarget#

    +

    get hoverTarget(): HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:58

    +

    Returns: HTMLElement

    +
    +

    targetElem#

    +

    get targetElem(): HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:54

    +

    Returns: HTMLElement

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TooltipProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    bindRef#

    +

    bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:66

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹TooltipProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TooltipProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹TooltipProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:71

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Protected getPosition#

    +

    getPosition(position: TooltipPosition, tooltipBounds: DOMRect, targetBounds: DOMRect): object

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:145

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    positionTooltipPosition
    tooltipBoundsDOMRect
    targetBoundsDOMRect
    +

    Returns: object

    +
      +
    • +

      bottom: number = top + tooltipBounds.height

      +
    • +
    • +

      left: number

      +
    • +
    • +

      right: number = left + tooltipBounds.width

      +
    • +
    • +

      top: number

      +
    • +
    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹TooltipProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TooltipProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    Protected onEnterTarget#

    +

    onEnterTarget(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:77

    +

    Returns: void

    +
    +

    Protected onLeaveTarget#

    +

    onLeaveTarget(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:83

    +

    Returns: void

    +
    +

    refreshPosition#

    +

    refreshPosition(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:88

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:202

    +

    Returns: Element‹›

    +
    +

    Protected setPosition#

    +

    setPosition(pos: object): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:138

    +

    Parameters:

    +

    pos: object

    + + + + + + + + + + + + + + + + + +
    NameType
    leftnumber
    topnumber
    +

    Returns: void

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.wizard/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizard/index.html new file mode 100644 index 0000000000..20ca63b4d5 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -0,0 +1,1827 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Wizard ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    Class: Wizard ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Wizard

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Wizard(props: Readonly‹WizardProps› | WizardProps): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardProps› | WizardProps
    +

    Returns: Wizard

    +

    + new Wizard(props: WizardProps, context: any): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardProps
    contextany
    +

    Returns: Wizard

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹WizardProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Accessors#

    +

    step#

    +

    get step(): number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:56

    +

    Returns: number

    +

    set step(step: number): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: void

    +
    +

    steps#

    +

    get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

    Defined in src/renderer/components/wizard/wizard.tsx:34

    +

    Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardProps
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    firstStep#

    +

    firstStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:77

    +

    Returns: any

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    Protected getValidStep#

    +

    getValidStep(step: number): number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: number

    +
    +

    isFirstStep#

    +

    isFirstStep(): boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:75

    +

    Returns: boolean

    +
    +

    isLastStep#

    +

    isLastStep(): boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:76

    +

    Returns: boolean

    +
    +

    lastStep#

    +

    lastStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:80

    +

    Returns: any

    +
    +

    nextStep#

    +

    nextStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:78

    +

    Returns: any

    +
    +

    prevStep#

    +

    prevStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:79

    +

    Returns: any

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:82

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    state#

    +

    state: object#

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/wizard/wizard.tsx:30

    +

    step#

    +

    step: number = this.getValidStep(this.props.step)

    +

    Defined in src/renderer/components/wizard/wizard.tsx:31

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html new file mode 100644 index 0000000000..58097d02ce --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: WizardLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    WizardLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardLayout(props: Readonly‹WizardLayoutProps› | WizardLayoutProps): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardLayoutProps› | WizardLayoutProps
    +

    Returns: WizardLayout

    +

    + new WizardLayout(props: WizardLayoutProps, context: any): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardLayoutProps
    contextany
    +

    Returns: WizardLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹WizardLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardLayoutProps
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardLayoutProps
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:18

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardstep/index.html new file mode 100644 index 0000000000..e0f42c815e --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -0,0 +1,1716 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardStep ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: WizardStep ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    WizardStep

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardStep(props: Readonly‹WizardStepProps› | WizardStepProps): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardStepProps› | WizardStepProps
    +

    Returns: WizardStep

    +

    + new WizardStep(props: WizardStepProps, context: any): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardStepProps
    contextany
    +

    Returns: WizardStep

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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

    +
    +

    props#

    +

    props: Readonly‹WizardStepProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:#

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: WizardStepState

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/wizard/wizard.tsx:136

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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

    +
    +

    Optional componentWillReceiveProps#

    +

    componentWillReceiveProps(nextProps: Readonly‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so 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:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/wizard/wizard.tsx:143

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    +

    Returns: SS | null

    +
    +

    next#

    +

    next(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:154

    +

    Returns: void

    +
    +

    prev#

    +

    prev(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:147

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:194

    +

    Returns: Element‹›

    +
    +

    renderLoading#

    +

    renderLoading(): Element‹›

    +

    Defined in src/renderer/components/wizard/wizard.tsx:186

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof WizardStepState

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: boolean

    +
    +

    submit#

    +

    submit(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:177

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/wizard/wizard.tsx:139

    +

    scrollable#

    +

    scrollable: true = true

    +

    Defined in src/renderer/components/wizard/wizard.tsx:140

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html new file mode 100644 index 0000000000..49697044d0 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -0,0 +1,1612 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRole - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterRole#

    +

    Hierarchy#

    +

    Role

    +

    ClusterRole

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ClusterRole(data: KubeJsonApiData): ClusterRole

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRole

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    rules#

    +

    rules: object[]

    +

    Inherited from Role.rules

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

    +

    Overrides Role.apiBase

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

    +
    +

    Static kind#

    +

    kind: string = "ClusterRole"

    +

    Overrides Role.kind

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides Role.namespaced

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRules#

    +

    getRules(): object[]

    +

    Inherited from Role.getRules

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html new file mode 100644 index 0000000000..4df802662c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -0,0 +1,1651 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterRoleBinding#

    +

    Hierarchy#

    +

    RoleBinding

    +

    ClusterRoleBinding

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    roleRef#

    +

    roleRef: object

    +

    Inherited from RoleBinding.roleRef

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Type declaration:#

    +
      +
    • +

      apiGroup? : string

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      name: string

      +
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Optional subjects#

    +

    subjects? : IRoleBindingSubject[]

    +

    Inherited from RoleBinding.subjects

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:18

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterrolebindings"

    +

    Overrides RoleBinding.apiBase

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:7

    +
    +

    Static kind#

    +

    kind: string = "ClusterRoleBinding"

    +

    Overrides RoleBinding.kind

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:5

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides RoleBinding.namespaced

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:6

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSubjectNames#

    +

    getSubjectNames(): string

    +

    Inherited from RoleBinding.getSubjectNames

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Returns: string

    +
    +

    getSubjects#

    +

    getSubjects(): IRoleBindingSubject[]

    +

    Inherited from RoleBinding.getSubjects

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Returns: IRoleBindingSubject[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html new file mode 100644 index 0000000000..85a861b8bc --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -0,0 +1,1615 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMap - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfigMap#

    +

    Hierarchy#

    + +

    ConfigMap

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfigMap(data: KubeJsonApiData): ConfigMap

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ConfigMap

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    data#

    +

    data: object

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    +

    Type declaration:#

    +
      +
    • [ param: string]: string
    • +
    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/configmaps"

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +
    +

    Static kind#

    +

    kind: string = "ConfigMap"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:8

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:9

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getKeys#

    +

    getKeys(): string[]

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html new file mode 100644 index 0000000000..749d15c393 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMapsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfigMapsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreConfigMap

    +

    ConfigMapsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfigMapsStore(): ConfigMapsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ConfigMapsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiConfigMap‹›› = configMapApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ConfigMap[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ConfigMap[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ConfigMap

    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ConfigMap

    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: ConfigMap): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: ConfigMap[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsConfigMap[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): ConfigMap[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ConfigMap[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ConfigMap[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ConfigMap[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): ConfigMap

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ConfigMap

    +
    +

    getByPath#

    +

    getByPath(path: string): ConfigMap

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ConfigMap

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ConfigMap[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ConfigMap[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsConfigMap[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ConfigMap): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ConfigMap[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsConfigMap[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ConfigMap[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ConfigMap[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ConfigMap[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ConfigMap[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ConfigMap[], __namedParameters: object): ConfigMap[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: ConfigMap[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ConfigMap[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ConfigMap): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: ConfigMap, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: ConfigMap

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: ConfigMap[], sorting?: function[], order?: "asc" | "desc"): ConfigMap[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsConfigMap[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ConfigMap[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ConfigMap[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsConfigMap[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    update#

    +

    update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    dataPartial‹ConfigMap
    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ConfigMap, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ConfigMap

    +

    request: function

    +

    ▸ (): Promise‹ConfigMap

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html new file mode 100644 index 0000000000..51b27ae241 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -0,0 +1,2368 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDResourceStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CRDResourceStore ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +

    KubeObjectStore‹T›

    +

    CRDResourceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹T›
    +

    Returns: CRDResourceStore

    +

    Properties#

    +

    api#

    +

    api: KubeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): T[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: T[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): T[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: T[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: T): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: T[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): T[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): T[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: T[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): T

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    getByPath(path: string): T

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): T[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: T[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: T[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹T›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹T›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹T[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: T[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: T[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: T): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: T, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    update#

    +

    update(item: T, data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html new file mode 100644 index 0000000000..40fda370a5 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -0,0 +1,2405 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CRDStore#

    +

    Hierarchy#

    +

    KubeObjectStoreCustomResourceDefinition

    +

    CRDStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CRDStore(): CRDStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Returns: CRDStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiCustomResourceDefinition‹›› = crdApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: CustomResourceDefinition[]

    +
    +

    groups#

    +

    get groups(): object

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    +

    Returns: object

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: CustomResourceDefinition[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹CustomResourceDefinition

    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹CustomResourceDefinition

    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: CustomResourceDefinition): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: CustomResourceDefinition[]

    +
    +

    getByGroup#

    +

    getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    groupstring
    pluralNamestring
    +

    Returns: CustomResourceDefinition‹›

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: CustomResourceDefinition[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): CustomResourceDefinition

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: CustomResourceDefinition

    +
    +

    getByObject#

    +

    getByObject(obj: KubeObject): CustomResourceDefinition‹›

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objKubeObject
    +

    Returns: CustomResourceDefinition‹›

    +
    +

    getByPath#

    +

    getByPath(path: string): CustomResourceDefinition

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CustomResourceDefinition

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: CustomResourceDefinition[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: CustomResourceDefinition): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCustomResourceDefinition[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | CustomResourceDefinition[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CustomResourceDefinition[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹CustomResourceDefinition[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹CustomResourceDefinition[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CustomResourceDefinition[], __namedParameters: object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: CustomResourceDefinition[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CustomResourceDefinition[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: CustomResourceDefinition): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: CustomResourceDefinition

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: CustomResourceDefinition‹›[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCustomResourceDefinition[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    update#

    +

    update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    dataPartial‹CustomResourceDefinition
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: CustomResourceDefinition

    +

    request: function

    +

    ▸ (): Promise‹CustomResourceDefinition

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html new file mode 100644 index 0000000000..dab5c5de11 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -0,0 +1,1766 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJob - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CronJob#

    +

    Hierarchy#

    + +

    CronJob

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CronJob(data: KubeJsonApiData): CronJob

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CronJob

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Overrides KubeObject.apiVersion

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:47

    +
    +

    kind#

    +

    kind: string

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:46

    +
    +

    metadata#

    +

    metadata: object

    +

    Overrides KubeObject.metadata

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:48

    +

    Type declaration:#

    +
      +
    • +

      annotations(): object

      +
    • +
    • +

      creationTimestamp: string

      +
    • +
    • +

      labels(): object

      +
    • +
    • +

      name: string

      +
    • +
    • +

      namespace: string

      +
    • +
    • +

      resourceVersion: string

      +
    • +
    • +

      selfLink: string

      +
    • +
    • +

      uid: string

      +
    • +
    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:62

    +

    Type declaration:#

    +
      +
    • +

      concurrencyPolicy: string

      +
    • +
    • +

      failedJobsHistoryLimit: number

      +
    • +
    • +

      jobTemplate(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
      • +
      • +

        creationTimestamp? : string

        +
      • +
      • +

        labels(): object

        +
      • +
      +
    • +
    • +

      spec(): object

      +
        +
      • +

        template(): object

        +
      • +
      • +

        metadata(): object

        +
          +
        • creationTimestamp? : string
        • +
        +
      • +
      • +

        spec(): object

        +
          +
        • +

          containers: IPodContainer[]

          +
        • +
        • +

          dnsPolicy: string

          +
        • +
        • +

          hostPID: boolean

          +
        • +
        • +

          restartPolicy: string

          +
        • +
        • +

          schedulerName: string

          +
        • +
        • +

          terminationGracePeriodSeconds: number

          +
        • +
        +
      • +
      +
    • +
    • +

      schedule: string

      +
    • +
    • +

      successfulJobsHistoryLimit: number

      +
    • +
    • +

      suspend: boolean

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:95

    +

    Type declaration:#

    +
      +
    • lastScheduleTime? : string
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/batch/v1beta1/cronjobs"

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:44

    +
    +

    Static kind#

    +

    kind: string = "CronJob"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:42

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:43

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getLastScheduleTime#

    +

    getLastScheduleTime(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:103

    +

    Returns: string

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSchedule#

    +

    getSchedule(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:110

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSuspendFlag#

    +

    getSuspendFlag(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:99

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    isNeverRun#

    +

    isNeverRun(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:114

    +

    Returns: boolean

    +
    +

    isSuspend#

    +

    isSuspend(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:126

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html new file mode 100644 index 0000000000..b096ee935c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -0,0 +1,2380 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CronJobStore#

    +

    Hierarchy#

    +

    KubeObjectStoreCronJob

    +

    CronJobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CronJobStore(): CronJobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: CronJobStore

    +

    Properties#

    +

    api#

    +

    api: CronJobApi‹› = cronJobApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): CronJob[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: CronJob[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): CronJob[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: CronJob[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹CronJob

    +

    Returns: Promise‹CronJob

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹CronJob

    +

    Returns: Promise‹CronJob

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: CronJob): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: CronJob[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCronJob[]
    +

    Returns: T[]

    +
    +

    getActiveJobsNum#

    +

    getActiveJobsNum(cronJob: CronJob): number

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobCronJob
    +

    Returns: number

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): CronJob[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: CronJob[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): CronJob[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: CronJob[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): CronJob

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: CronJob

    +
    +

    getByPath#

    +

    getByPath(path: string): CronJob

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CronJob

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CronJob[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: CronJob[]

    +
    +

    getStatuses#

    +

    getStatuses(cronJobs?: CronJob[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobs?CronJob[]
    +

    Returns: object

    +
      +
    • +

      scheduled: number = 0

      +
    • +
    • +

      suspended: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: CronJob): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: CronJob[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCronJob[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹CronJob

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | CronJob[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CronJob[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹CronJob

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹CronJob[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹CronJob[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CronJob[], __namedParameters: object): CronJob[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: CronJob[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CronJob[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: CronJob): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: CronJob, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: CronJob

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: CronJob): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: CronJob[], sorting?: function[], order?: "asc" | "desc"): CronJob[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsCronJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: CronJob[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: CronJob): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: CronJob[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCronJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: CronJob): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    update#

    +

    update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCronJob
    dataPartial‹CronJob
    +

    Returns: Promise‹CronJob

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: CronJob, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: CronJob

    +

    request: function

    +

    ▸ (): Promise‹CronJob

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html new file mode 100644 index 0000000000..9e7acfb143 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -0,0 +1,1896 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CustomResourceDefinition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CustomResourceDefinition#

    +

    Hierarchy#

    + +

    CustomResourceDefinition

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CustomResourceDefinition

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    +

    Type declaration:#

    +
      +
    • +

      additionalPrinterColumns? : AdditionalPrinterColumnsV1Beta[]

      +
    • +
    • +

      conversion(): object

      +
    • +
    • +

      strategy? : string

      +
    • +
    • +

      webhook? : any

      +
    • +
    • +

      group: string

      +
    • +
    • +

      names(): object

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      listKind: string

      +
    • +
    • +

      plural: string

      +
    • +
    • +

      singular: string

      +
    • +
    • +

      scope: "Namespaced" | "Cluster" | string

      +
    • +
    • +

      validation? : any

      +
    • +
    • +

      version? : string

      +
    • +
    • +

      versions: object[]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:49

    +

    Type declaration:#

    +
      +
    • +

      acceptedNames(): object

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      listKind: string

      +
    • +
    • +

      plural: string

      +
    • +
    • +

      shortNames: string[]

      +
    • +
    • +

      singular: string

      +
    • +
    • +

      conditions: object[]

      +
    • +
    • +

      storedVersions: string[]

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:23

    +
    +

    Static kind#

    +

    kind: string = "CustomResourceDefinition"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:21

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:22

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    +

    Returns: object[]

    +
    +

    getConversion#

    +

    getConversion(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    +

    Returns: string

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getGroup#

    +

    getGroup(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    +

    Returns: string

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNames#

    +

    getNames(): object

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    +

    Returns: object

    +
      +
    • +

      kind: string

      +
    • +
    • +

      listKind: string

      +
    • +
    • +

      plural: string

      +
    • +
    • +

      singular: string

      +
    • +
    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPluralName#

    +

    getPluralName(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:82

    +

    Returns: string

    +
    +

    getPrinterColumns#

    +

    getPrinterColumns(ignorePriority: boolean): AdditionalPrinterColumnsV1[]

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    ignorePrioritybooleantrue
    +

    Returns: AdditionalPrinterColumnsV1[]

    +
    +

    getResourceApiBase#

    +

    getResourceApiBase(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    +

    Returns: string

    +
    +

    getResourceKind#

    +

    getResourceKind(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    +

    Returns: string

    +
    +

    getResourceTitle#

    +

    getResourceTitle(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    +

    Returns: string

    +
    +

    getResourceUrl#

    +

    getResourceUrl(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getScope#

    +

    getScope(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getStoredVersions#

    +

    getStoredVersions(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getValidation#

    +

    getValidation(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    +

    Returns: string

    +
    +

    getVersion#

    +

    getVersion(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    +

    Returns: string

    +
    +

    isNamespaced#

    +

    isNamespaced(): boolean

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html new file mode 100644 index 0000000000..302cb1e18a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -0,0 +1,1802 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    Class: DaemonSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    DaemonSet

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DaemonSet(data: KubeJsonApiData): DaemonSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: DaemonSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    +

    Type declaration:#

    +
      +
    • +

      revisionHistoryLimit: number

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        creationTimestamp? : string

        +
      • +
      • +

        labels(): object

        +
      • +
      • +

        name: string

        +
      • +
      +
    • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
      • +
      • +

        containers: IPodContainer[]

        +
      • +
      • +

        dnsPolicy: string

        +
      • +
      • +

        hostPID: boolean

        +
      • +
      • +

        initContainers? : IPodContainer[]

        +
      • +
      • +

        nodeSelector(): object

        +
      • +
      • +

        restartPolicy: string

        +
      • +
      • +

        schedulerName: string

        +
      • +
      • +

        securityContext(): object

        +
      • +
      • +

        terminationGracePeriodSeconds: number

        +
      • +
      • +

        tolerations: object[]

        +
      • +
      +
    • +
    • +

      updateStrategy(): object

      +
    • +
    • +

      rollingUpdate(): object

      +
        +
      • maxUnavailable: number
      • +
      +
    • +
    • +

      type: string

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:55

    +

    Type declaration:#

    +
      +
    • +

      currentNumberScheduled: number

      +
    • +
    • +

      desiredNumberScheduled: number

      +
    • +
    • +

      numberAvailable: number

      +
    • +
    • +

      numberMisscheduled: number

      +
    • +
    • +

      numberReady: number

      +
    • +
    • +

      numberUnavailable: number

      +
    • +
    • +

      observedGeneration: number

      +
    • +
    • +

      updatedNumberScheduled: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/apps/v1/daemonsets"

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:11

    +
    +

    Static kind#

    +

    kind: string = "DaemonSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:9

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:10

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImages#

    +

    getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html new file mode 100644 index 0000000000..25e92c274b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -0,0 +1,2423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DaemonSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreDaemonSet

    +

    DaemonSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DaemonSetStore(): DaemonSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: DaemonSetStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiDaemonSet‹›› = daemonSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: DaemonSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: DaemonSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹DaemonSet

    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹DaemonSet

    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: DaemonSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: DaemonSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDaemonSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): DaemonSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: DaemonSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): DaemonSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: DaemonSet[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): DaemonSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: DaemonSet

    +
    +

    getByPath#

    +

    getByPath(path: string): DaemonSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: DaemonSet

    +
    +

    getChildPods#

    +

    getChildPods(daemonSet: DaemonSet): Pod[]

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSetDaemonSet
    +

    Returns: Pod[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: DaemonSet[]

    +
    +

    getStatuses#

    +

    getStatuses(daemonSets?: DaemonSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSets?DaemonSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: DaemonSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: DaemonSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDaemonSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | DaemonSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | DaemonSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹DaemonSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹DaemonSet[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(daemonSet: DaemonSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSetDaemonSet
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: DaemonSet[], __namedParameters: object): DaemonSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: DaemonSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: DaemonSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: DaemonSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: DaemonSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: DaemonSet

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: DaemonSet[], sorting?: function[], order?: "asc" | "desc"): DaemonSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsDaemonSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: DaemonSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: DaemonSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDaemonSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    update#

    +

    update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    dataPartial‹DaemonSet
    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: DaemonSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: DaemonSet

    +

    request: function

    +

    ▸ (): Promise‹DaemonSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html new file mode 100644 index 0000000000..6535bc303a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -0,0 +1,1867 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Deployment - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Deployment#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    Deployment

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Deployment(data: KubeJsonApiData): Deployment

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Deployment

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:75

    +

    Type declaration:#

    +
      +
    • +

      replicas: number

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      strategy(): object

      +
    • +
    • +

      rollingUpdate(): object

      +
        +
      • +

        maxSurge: number

        +
      • +
      • +

        maxUnavailable: number

        +
      • +
      +
    • +
    • +

      type: string

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
      • +
      • +

        creationTimestamp? : string

        +
      • +
      • +

        labels(): object

        +
      • +
      +
    • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
      • +
      • +

        containers: object[]

        +
      • +
      • +

        dnsPolicy: string

        +
      • +
      • +

        nodeSelector(): object

        +
      • +
      • +

        restartPolicy: string

        +
      • +
      • +

        schedulerName: string

        +
      • +
      • +

        securityContext(): object

        +
      • +
      • +

        serviceAccount: string

        +
      • +
      • +

        serviceAccountName: string

        +
      • +
      • +

        terminationGracePeriodSeconds: number

        +
      • +
      • +

        tolerations? : object[]

        +
      • +
      • +

        volumes? : object[]

        +
      • +
      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:154

    +

    Type declaration:#

    +
      +
    • +

      availableReplicas? : number

      +
    • +
    • +

      conditions: object[]

      +
    • +
    • +

      observedGeneration: number

      +
    • +
    • +

      readyReplicas: number

      +
    • +
    • +

      replicas: number

      +
    • +
    • +

      unavailableReplicas? : number

      +
    • +
    • +

      updatedReplicas: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/apps/v1/deployments"

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:73

    +
    +

    Static kind#

    +

    kind: string = "Deployment"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:71

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:72

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(activeOnly: boolean): object[]

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:171

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleanfalse
    +

    Returns: object[]

    +
    +

    getConditionsText#

    +

    getConditionsText(activeOnly: boolean): string

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:183

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleantrue
    +

    Returns: string

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:187

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html new file mode 100644 index 0000000000..98bbe092ed --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -0,0 +1,1866 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DeploymentApi#

    +

    Hierarchy#

    + +

    DeploymentApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Deployment
    +

    Returns: DeploymentApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Deployment

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Deployment

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Deployment

    +

    Returns: Promise‹Deployment

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Deployment

    +
    +

    getReplicas#

    +

    getReplicas(params: object): Promise‹number›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: Promise‹number›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    Protected getScaleApiUrl#

    +

    getScaleApiUrl(params: object): string

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Deployment[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    restart#

    +

    restart(params: object): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    scale#

    +

    scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    replicas: number

    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Deployment

    +

    Returns: Promise‹Deployment

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html new file mode 100644 index 0000000000..f2a1110eee --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -0,0 +1,2411 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DeploymentStore#

    +

    Hierarchy#

    +

    KubeObjectStoreDeployment

    +

    DeploymentStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DeploymentStore(): DeploymentStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: DeploymentStore

    +

    Properties#

    +

    api#

    +

    api: DeploymentApi‹› = deploymentApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Deployment[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Deployment[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Deployment[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Deployment[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Deployment

    +

    Returns: Promise‹Deployment

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Deployment

    +

    Returns: Promise‹Deployment

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Deployment): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Deployment[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDeployment[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Deployment[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Deployment[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Deployment[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Deployment[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Deployment

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Deployment

    +
    +

    getByPath#

    +

    getByPath(path: string): Deployment

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Deployment

    +
    +

    getChildPods#

    +

    getChildPods(deployment: Deployment): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: Pod‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Deployment[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Deployment[]

    +
    +

    getStatuses#

    +

    getStatuses(deployments?: Deployment[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deployments?Deployment[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Deployment): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Deployment[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDeployment[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Deployment

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Deployment[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Deployment[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Deployment

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Deployment[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Deployment[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(deployment: Deployment): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Deployment[], __namedParameters: object): Deployment[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Deployment[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Deployment[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Deployment): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Deployment, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Deployment

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Deployment): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Deployment[]): Deployment‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDeployment[]
    +

    Returns: Deployment‹›[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Deployment): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Deployment[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDeployment[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Deployment): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Deployment, data: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDeployment
    dataPartial‹Deployment
    +

    Returns: Promise‹Deployment

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Deployment, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Deployment

    +

    request: function

    +

    ▸ (): Promise‹Deployment

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html new file mode 100644 index 0000000000..0439bc3cf4 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -0,0 +1,1624 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Endpoint - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Endpoint#

    +

    Hierarchy#

    + +

    Endpoint

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Endpoint(data: KubeJsonApiData): Endpoint

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Endpoint

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    subsets#

    +

    subsets: IEndpointSubset[]

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/endpoints"

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107

    +
    +

    Static kind#

    +

    kind: string = "Endpoints"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getEndpointSubsets#

    +

    getEndpointSubsets(): EndpointSubset[]

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    +

    Returns: EndpointSubset[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    toString#

    +

    toString(): string

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    +

    Returns: string

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html new file mode 100644 index 0000000000..260eb006bf --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EndpointStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EndpointStore#

    +

    Hierarchy#

    +

    KubeObjectStoreEndpoint

    +

    EndpointStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EndpointStore(): EndpointStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: EndpointStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiEndpoint‹›› = endpointApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Endpoint[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Endpoint[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Endpoint

    +

    Returns: Promise‹Endpoint

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Endpoint

    +

    Returns: Promise‹Endpoint

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Endpoint): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Endpoint[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsEndpoint[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Endpoint[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Endpoint[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Endpoint[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Endpoint[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Endpoint

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Endpoint

    +
    +

    getByPath#

    +

    getByPath(path: string): Endpoint

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Endpoint

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Endpoint[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Endpoint[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsEndpoint[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Endpoint): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Endpoint[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsEndpoint[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Endpoint[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Endpoint[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Endpoint[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Endpoint[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Endpoint[], __namedParameters: object): Endpoint[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Endpoint[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Endpoint[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Endpoint): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Endpoint, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Endpoint

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Endpoint): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Endpoint[], sorting?: function[], order?: "asc" | "desc"): Endpoint[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsEndpoint[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Endpoint[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Endpoint): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Endpoint[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsEndpoint[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Endpoint): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Endpoint, data: Partial‹Endpoint›): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    dataPartial‹Endpoint
    +

    Returns: Promise‹Endpoint

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Endpoint, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Endpoint

    +

    request: function

    +

    ▸ (): Promise‹Endpoint

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html new file mode 100644 index 0000000000..ee8cd10ca2 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -0,0 +1,2381 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EventStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EventStore#

    +

    Hierarchy#

    +

    KubeObjectStoreKubeEvent

    +

    EventStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EventStore(): EventStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: EventStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiKubeEvent‹›› = eventApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+events/event.store.ts:13

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    limit#

    +

    limit: number = 1000

    +

    Overrides KubeObjectStore.limit

    +

    Defined in src/renderer/components/+events/event.store.ts:14

    +
    +

    saveLimit#

    +

    saveLimit: number = 50000

    +

    Defined in src/renderer/components/+events/event.store.ts:15

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: KubeEvent[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: KubeEvent[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(): void

    +

    Overrides KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/components/+events/event.store.ts:17

    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹KubeEvent

    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹KubeEvent

    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: KubeEvent): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: KubeEvent[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): KubeEvent[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: KubeEvent[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): KubeEvent[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: KubeEvent[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): KubeEvent

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: KubeEvent

    +
    +

    getByPath#

    +

    getByPath(path: string): KubeEvent

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: KubeEvent

    +
    +

    getEventsByObject#

    +

    getEventsByObject(obj: KubeObject): KubeEvent[]

    +

    Defined in src/renderer/components/+events/event.store.ts:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objKubeObject
    +

    Returns: KubeEvent[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: KubeEvent[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: KubeEvent[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    getWarnings#

    +

    getWarnings(): KubeEvent‹›[]

    +

    Defined in src/renderer/components/+events/event.store.ts:37

    +

    Returns: KubeEvent‹›[]

    +
    +

    getWarningsCount#

    +

    getWarningsCount(): number

    +

    Defined in src/renderer/components/+events/event.store.ts:56

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: KubeEvent): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: KubeEvent[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsKubeEvent[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | KubeEvent[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | KubeEvent[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹KubeEvent[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹KubeEvent[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: KubeEvent[], __namedParameters: object): KubeEvent[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: KubeEvent[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: KubeEvent[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: KubeEvent): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: KubeEvent, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: KubeEvent

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: KubeEvent[]): KubeEvent‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+events/event.store.ts:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: KubeEvent‹›[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: KubeEvent[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsKubeEvent[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    update#

    +

    update(item: KubeEvent, data: Partial‹KubeEvent›): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    dataPartial‹KubeEvent
    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: KubeEvent, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: KubeEvent

    +

    request: function

    +

    ▸ (): Promise‹KubeEvent

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html new file mode 100644 index 0000000000..86b185cc0c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -0,0 +1,1771 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HorizontalPodAutoscaler - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: HorizontalPodAutoscaler#

    +

    Hierarchy#

    + +

    HorizontalPodAutoscaler

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new HorizontalPodAutoscaler(data: KubeJsonApiData): HorizontalPodAutoscaler

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: HorizontalPodAutoscaler

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    +

    Type declaration:#

    +
      +
    • +

      maxReplicas: number

      +
    • +
    • +

      metrics: IHpaMetric[]

      +
    • +
    • +

      minReplicas: number

      +
    • +
    • +

      scaleTargetRef(): object

      +
    • +
    • +

      apiVersion: string

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      name: string

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:56

    +

    Type declaration:#

    +
      +
    • +

      conditions: object[]

      +
    • +
    • +

      currentMetrics: IHpaMetric[]

      +
    • +
    • +

      currentReplicas: number

      +
    • +
    • +

      desiredReplicas: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/autoscaling/v2beta1/horizontalpodautoscalers"

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:44

    +
    +

    Static kind#

    +

    kind: string = "HorizontalPodAutoscaler"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:42

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:43

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    +

    Returns: object[]

    +
    +

    getCurrentMetrics#

    +

    getCurrentMetrics(): IHpaMetric[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    +

    Returns: IHpaMetric[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getMaxPods#

    +

    getMaxPods(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    +

    Returns: number

    +
    +

    Protected getMetricName#

    +

    getMetricName(metric: IHpaMetric): string

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    metricIHpaMetric
    +

    Returns: string

    +
    +

    getMetricValues#

    +

    getMetricValues(metric: IHpaMetric): string

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    metricIHpaMetric
    +

    Returns: string

    +
    +

    getMetrics#

    +

    getMetrics(): IHpaMetric[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    +

    Returns: IHpaMetric[]

    +
    +

    getMinPods#

    +

    getMinPods(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    +

    Returns: number

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html new file mode 100644 index 0000000000..503819bf0f --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HPAStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: HPAStore#

    +

    Hierarchy#

    +

    KubeObjectStoreHorizontalPodAutoscaler

    +

    HPAStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new HPAStore(): HPAStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: HPAStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiHorizontalPodAutoscaler‹›› = hpaApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: HorizontalPodAutoscaler[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹HorizontalPodAutoscaler

    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹HorizontalPodAutoscaler

    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: HorizontalPodAutoscaler): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: HorizontalPodAutoscaler[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsHorizontalPodAutoscaler[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    getByPath#

    +

    getByPath(path: string): HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsHorizontalPodAutoscaler[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: HorizontalPodAutoscaler): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsHorizontalPodAutoscaler[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | HorizontalPodAutoscaler[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | HorizontalPodAutoscaler[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹HorizontalPodAutoscaler[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹HorizontalPodAutoscaler[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: HorizontalPodAutoscaler[], __namedParameters: object): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: HorizontalPodAutoscaler[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: HorizontalPodAutoscaler): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: HorizontalPodAutoscaler, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: HorizontalPodAutoscaler

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: HorizontalPodAutoscaler[], sorting?: function[], order?: "asc" | "desc"): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsHorizontalPodAutoscaler[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsHorizontalPodAutoscaler[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    update#

    +

    update(item: HorizontalPodAutoscaler, data: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    dataPartial‹HorizontalPodAutoscaler
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: HorizontalPodAutoscaler

    +

    request: function

    +

    ▸ (): Promise‹HorizontalPodAutoscaler

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html new file mode 100644 index 0000000000..22fff2704a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -0,0 +1,1695 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Ingress - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Ingress#

    +

    Hierarchy#

    + +

    Ingress

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Ingress(data: KubeJsonApiData): Ingress

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Ingress

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    +

    Type declaration:#

    +
      +
    • +

      backend? : IExtensionsBackend

      +
    • +
    • +

      defaultBackend? : INetworkingBackend & object

      +
    • +
    • +

      rules? : object[]

      +
    • +
    • +

      tls: object[]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:94

    +

    Type declaration:#

    +
      +
    • +

      loadBalancer(): object

      +
    • +
    • +

      ingress: ILoadBalancerIngress[]

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/networking.k8s.io/v1/ingresses"

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:68

    +
    +

    Static kind#

    +

    kind: string = "Ingress"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:66

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:67

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getHosts#

    +

    getHosts(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getLoadBalancers#

    +

    getLoadBalancers(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPorts#

    +

    getPorts(): string

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRoutes#

    +

    getRoutes(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    +

    Returns: string[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getServiceNamePort#

    +

    getServiceNamePort(): object

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    +

    Returns: object

    +
      +
    • +

      serviceName: string

      +
    • +
    • +

      servicePort: string | number

      +
    • +
    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html new file mode 100644 index 0000000000..cd1d017021 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -0,0 +1,1765 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: IngressApi#

    +

    Hierarchy#

    + +

    IngressApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new IngressApi(options: IKubeApiOptions‹Ingress›): IngressApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Ingress
    +

    Returns: IngressApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Ingress

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Ingress

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Ingress

    +

    Returns: Promise‹Ingress

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Ingress

    +
    +

    getMetrics#

    +

    getMetrics(ingress: string, namespace: string): Promise‹IIngressMetrics›

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    ingressstring
    namespacestring
    +

    Returns: Promise‹IIngressMetrics›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Ingress[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Ingress

    +

    Returns: Promise‹Ingress

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html new file mode 100644 index 0000000000..ce8747e81a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -0,0 +1,2384 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: IngressStore#

    +

    Hierarchy#

    +

    KubeObjectStoreIngress

    +

    IngressStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new IngressStore(): IngressStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: IngressStore

    +

    Properties#

    +

    api#

    +

    api: IngressApi‹› = ingressApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IIngressMetrics = null

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Ingress[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Ingress[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Ingress[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Ingress[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Ingress

    +

    Returns: Promise‹Ingress

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Ingress

    +

    Returns: Promise‹Ingress

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Ingress): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Ingress[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsIngress[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Ingress[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Ingress[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Ingress[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Ingress[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Ingress

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Ingress

    +
    +

    getByPath#

    +

    getByPath(path: string): Ingress

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Ingress

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Ingress[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Ingress[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Ingress[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsIngress[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Ingress): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Ingress[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsIngress[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Ingress

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Ingress[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Ingress[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Ingress

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Ingress[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Ingress[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(ingress: Ingress): Promise‹void›

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ingressIngress
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Ingress[], __namedParameters: object): Ingress[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Ingress[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Ingress[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Ingress): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Ingress, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Ingress

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Ingress): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Ingress[], sorting?: function[], order?: "asc" | "desc"): Ingress[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsIngress[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Ingress[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Ingress): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Ingress[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsIngress[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Ingress): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Ingress, data: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemIngress
    dataPartial‹Ingress
    +

    Returns: Promise‹Ingress

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Ingress, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Ingress

    +

    request: function

    +

    ▸ (): Promise‹Ingress

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html new file mode 100644 index 0000000000..dd0719e445 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -0,0 +1,1853 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Job - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Job#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    Job

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Job(data: KubeJsonApiData): Job

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Job

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/job.api.ts:14

    +

    Type declaration:#

    +
      +
    • +

      backoffLimit? : number

      +
    • +
    • +

      completions? : number

      +
    • +
    • +

      containers? : IPodContainer[]

      +
    • +
    • +

      dnsPolicy? : string

      +
    • +
    • +

      parallelism? : number

      +
    • +
    • +

      restartPolicy? : string

      +
    • +
    • +

      schedulerName? : string

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      serviceAccount? : string

      +
    • +
    • +

      serviceAccountName? : string

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
      • +
      • +

        creationTimestamp? : string

        +
      • +
      • +

        labels(): object

        +
      • +
      +
    • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
      • +
      • +

        containers: IPodContainer[]

        +
      • +
      • +

        dnsPolicy: string

        +
      • +
      • +

        hostPID: boolean

        +
      • +
      • +

        nodeSelector(): object

        +
      • +
      • +

        restartPolicy: string

        +
      • +
      • +

        schedulerName: string

        +
      • +
      • +

        terminationGracePeriodSeconds: number

        +
      • +
      • +

        tolerations? : object[]

        +
      • +
      +
    • +
    • +

      terminationGracePeriodSeconds? : number

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/job.api.ts:60

    +

    Type declaration:#

    +
      +
    • +

      completionTime: string

      +
    • +
    • +

      conditions: object[]

      +
    • +
    • +

      startTime: string

      +
    • +
    • +

      succeeded: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/batch/v1/jobs"

    +

    Defined in src/renderer/api/endpoints/job.api.ts:12

    +
    +

    Static kind#

    +

    kind: string = "Job"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/job.api.ts:10

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/job.api.ts:11

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(): CancelablePromise‹KubeJsonApiData›

    +

    Overrides KubeObject.delete

    +

    Defined in src/renderer/api/endpoints/job.api.ts:101

    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCompletions#

    +

    getCompletions(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:77

    +

    Returns: number

    +
    +

    getCondition#

    +

    getCondition(): object

    +

    Defined in src/renderer/api/endpoints/job.api.ts:85

    +

    Returns: object

    +
      +
    • +

      lastProbeTime: string

      +
    • +
    • +

      lastTransitionTime: string

      +
    • +
    • +

      message? : string

      +
    • +
    • +

      status: string

      +
    • +
    • +

      type: string

      +
    • +
    +
    +

    getDesiredCompletions#

    +

    getDesiredCompletions(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:73

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImages#

    +

    getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/job.api.ts:95

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getParallelism#

    +

    getParallelism(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:81

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html new file mode 100644 index 0000000000..2b5962b33c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -0,0 +1,2414 @@ + + + + + + + + + + + + + + + + + + + + + + Class: JobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: JobStore#

    +

    Hierarchy#

    +

    KubeObjectStoreJob

    +

    JobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new JobStore(): JobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: JobStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiJob‹›› = jobApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Job[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Job[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Job[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Job[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Job›): Promise‹Job

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Job

    +

    Returns: Promise‹Job

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Job›): Promise‹Job

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Job

    +

    Returns: Promise‹Job

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Job): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Job[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsJob[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Job[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Job[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Job[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Job[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Job

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Job

    +
    +

    getByPath#

    +

    getByPath(path: string): Job

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Job

    +
    +

    getChildPods#

    +

    getChildPods(job: Job): Pod[]

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    jobJob
    +

    Returns: Pod[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Job[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Job[]

    +
    +

    getJobsByOwner#

    +

    getJobsByOwner(cronJob: CronJob): Job‹›[]

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobCronJob
    +

    Returns: Job‹›[]

    +
    +

    getStatuses#

    +

    getStatuses(jobs?: Job[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    jobs?Job[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    • +

      succeeded: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Job): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Job[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsJob[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Job

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Job[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Job[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Job

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Job[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Job[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Job[], __namedParameters: object): Job[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Job[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Job[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Job): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Job, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Job

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Job): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Job[], sorting?: function[], order?: "asc" | "desc"): Job[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Job[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Job): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Job[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Job): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Job, data: Partial‹Job›): Promise‹Job

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemJob
    dataPartial‹Job
    +

    Returns: Promise‹Job

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Job, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Job

    +

    request: function

    +

    ▸ (): Promise‹Job

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html new file mode 100644 index 0000000000..b39b578cea --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -0,0 +1,1716 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeApi ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeApi ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +
      +
    • KubeApi
    • +
    +

    PodsApi

    +

    NodesApi

    +

    DeploymentApi

    +

    IngressApi

    +

    PersistentVolumeClaimsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeApi(options: IKubeApiOptions‹T›): KubeApi

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹T›
    +

    Returns: KubeApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹T›

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹T›

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹T›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹T[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html new file mode 100644 index 0000000000..6101ec567c --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -0,0 +1,1803 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEvent - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeEvent#

    +

    Hierarchy#

    + +

    KubeEvent

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeEvent(data: KubeJsonApiData): KubeEvent

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeEvent

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    count#

    +

    count: number

    +

    Defined in src/renderer/api/endpoints/events.api.ts:30

    +
    +

    eventTime#

    +

    eventTime: null

    +

    Defined in src/renderer/api/endpoints/events.api.ts:32

    +
    +

    firstTimestamp#

    +

    firstTimestamp: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:28

    +
    +

    involvedObject#

    +

    involvedObject: object

    +

    Defined in src/renderer/api/endpoints/events.api.ts:13

    +

    Type declaration:#

    +
      +
    • +

      apiVersion: string

      +
    • +
    • +

      fieldPath: string

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      name: string

      +
    • +
    • +

      namespace: string

      +
    • +
    • +

      resourceVersion: string

      +
    • +
    • +

      uid: string

      +
    • +
    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    lastTimestamp#

    +

    lastTimestamp: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:29

    +
    +

    message#

    +

    message: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:23

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    reason#

    +

    reason: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:22

    +
    +

    reportingComponent#

    +

    reportingComponent: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:33

    +
    +

    reportingInstance#

    +

    reportingInstance: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:34

    +
    +

    source#

    +

    source: object

    +

    Defined in src/renderer/api/endpoints/events.api.ts:24

    +

    Type declaration:#

    +
      +
    • +

      component: string

      +
    • +
    • +

      host: string

      +
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    type#

    +

    type: "Normal" | "Warning" | string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:31

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/events"

    +

    Defined in src/renderer/api/endpoints/events.api.ts:11

    +
    +

    Static kind#

    +

    kind: string = "Event"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/events.api.ts:9

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/events.api.ts:10

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getFirstSeenTime#

    +

    getFirstSeenTime(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:46

    +

    Returns: string

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getLastSeenTime#

    +

    getLastSeenTime(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:52

    +

    Returns: string

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSource#

    +

    getSource(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:40

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    isWarning#

    +

    isWarning(): boolean

    +

    Defined in src/renderer/api/endpoints/events.api.ts:36

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html new file mode 100644 index 0000000000..df5a317df5 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -0,0 +1,1567 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObject - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObject#

    +

    Hierarchy#

    +
      +
    • KubeObject
    • +
    +

    Node

    +

    CronJob

    +

    ConfigMap

    +

    Secret

    +

    ResourceQuota

    +

    LimitRange

    +

    HorizontalPodAutoscaler

    +

    PodDisruptionBudget

    +

    Service

    +

    Endpoint

    +

    Ingress

    +

    NetworkPolicy

    +

    PersistentVolume

    +

    PersistentVolumeClaim

    +

    StorageClass

    +

    Namespace

    +

    KubeEvent

    +

    ServiceAccount

    +

    Role

    +

    RoleBinding

    +

    CustomResourceDefinition

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObject(data: KubeJsonApiData): KubeObject

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeObject

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-object.ts:70

    +
    +

    Static namespaced#

    +

    namespaced: boolean

    +

    Defined in src/renderer/api/kube-object.ts:71

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html new file mode 100644 index 0000000000..9393787a7b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -0,0 +1,2348 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectStore ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +
      +
    • ItemStore‹T›
    • +
    +

    KubeObjectStore

    +

    EventStore

    +

    PodsStore

    +

    NodesStore

    +

    DeploymentStore

    +

    DaemonSetStore

    +

    StatefulSetStore

    +

    JobStore

    +

    CronJobStore

    +

    ConfigMapsStore

    +

    SecretsStore

    +

    ReplicaSetStore

    +

    ResourceQuotasStore

    +

    LimitRangesStore

    +

    HPAStore

    +

    PodDisruptionBudgetsStore

    +

    ServiceStore

    +

    EndpointStore

    +

    IngressStore

    +

    NetworkPolicyStore

    +

    PersistentVolumesStore

    +

    VolumeClaimStore

    +

    StorageClassStore

    +

    NamespaceStore

    +

    ServiceAccountsStore

    +

    RolesStore

    +

    RoleBindingsStore

    +

    CRDStore

    +

    CRDResourceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectStore(): KubeObjectStore

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: KubeObjectStore

    +

    Properties#

    +

    Abstract api#

    +

    api: KubeApi‹T›

    +

    Defined in src/renderer/kube-object.store.ts:21

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): T[]

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: T[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): T[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: T[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹T›): Promise‹T›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: T): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: T[]): T[]

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): T[]

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): T[]

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: T[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): T

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    getByPath(path: string): T

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): T[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: T[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: T[]): Record‹string, number›

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | T[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹T›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹T[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: T[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: T[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: T): Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: T, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    update#

    +

    update(item: T, data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html new file mode 100644 index 0000000000..168fbc74a2 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html @@ -0,0 +1,1641 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LimitRange - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LimitRange#

    +

    Hierarchy#

    + +

    LimitRange

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LimitRange(data: KubeJsonApiData): LimitRange

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: LimitRange

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:38

    +

    Type declaration:#

    +
      +
    • limits: LimitRangeItem[]
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/limitranges"

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:36

    +
    +

    Static kind#

    +

    kind: string = "LimitRange"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:34

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:35

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getContainerLimits#

    +

    getContainerLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:42

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPVCLimits#

    +

    getPVCLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:50

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getPodLimits#

    +

    getPodLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:46

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html new file mode 100644 index 0000000000..4c59aa3870 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LimitRangesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LimitRangesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreLimitRange

    +

    LimitRangesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LimitRangesStore(): LimitRangesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: LimitRangesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiLimitRange‹›› = limitRangeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: LimitRange[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: LimitRange[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: LimitRange): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: LimitRange[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): LimitRange[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: LimitRange[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): LimitRange[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: LimitRange[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): LimitRange

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: LimitRange

    +
    +

    getByPath#

    +

    getByPath(path: string): LimitRange

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: LimitRange

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: LimitRange[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: LimitRange[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: LimitRange): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: LimitRange[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | LimitRange[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | LimitRange[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹LimitRange[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹LimitRange[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: LimitRange[], __namedParameters: object): LimitRange[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: LimitRange[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: LimitRange[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: LimitRange): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: LimitRange, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: LimitRange

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: LimitRange): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: LimitRange[], sorting?: function[], order?: "asc" | "desc"): LimitRange[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsLimitRange[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: LimitRange[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: LimitRange): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: LimitRange[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: LimitRange): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    update#

    +

    update(item: LimitRange, data: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    dataPartial‹LimitRange
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: LimitRange, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: LimitRange

    +

    request: function

    +

    ▸ (): Promise‹LimitRange

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html new file mode 100644 index 0000000000..fa36f9baa2 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -0,0 +1,1603 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Namespace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Namespace#

    +

    Hierarchy#

    + +

    Namespace

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Namespace(data: KubeJsonApiData): Namespace

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Namespace

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    +

    Type declaration:#

    +
      +
    • phase: string
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/namespaces"

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:14

    +
    +

    Static kind#

    +

    kind: string = "Namespace"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:12

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:13

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): string

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html new file mode 100644 index 0000000000..757d0f08cc --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -0,0 +1,2534 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NamespaceStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNamespace

    +

    NamespaceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceStore(): NamespaceStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:34

    +

    Returns: NamespaceStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiNamespace‹›› = namespacesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:32

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    allowedNamespaces#

    +

    get allowedNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:92

    +

    Returns: string[]

    +
    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Namespace[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Namespace[]

    +
    +

    contextNamespaces#

    +

    get contextNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:99

    +

    Returns: string[]

    +
    +

    hasAllContexts#

    +

    get hasAllContexts(): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:148

    +

    Returns: boolean

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Namespace[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Namespace[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Namespace

    +

    Returns: Promise‹Namespace

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Namespace

    +

    Returns: Promise‹Namespace

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Namespace): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Namespace[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNamespace[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Namespace[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Namespace[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Namespace[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Namespace[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Namespace

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Namespace

    +
    +

    getByPath#

    +

    getByPath(path: string): Namespace

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Namespace

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Namespace[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Namespace[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Namespace[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNamespace[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi‹any›[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:109

    +

    Returns: KubeApi‹any›[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    hasContext#

    +

    hasContext(namespaces: string | string[]): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:144

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacesstring | string[]
    +

    Returns: boolean

    +
    +

    isSelected#

    +

    isSelected(item: Namespace): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Namespace[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNamespace[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Namespace

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Namespace[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Namespace[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Namespace

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace

    +
    +

    Protected loadItems#

    +

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:118

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹Namespace‹›[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Namespace[], __namedParameters: object): Namespace[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Namespace[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Namespace[]

    +
    +

    onContextChange#

    +

    onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:50

    +

    Parameters:

    +

    callback: function

    +

    ▸ (contextNamespaces: string[]): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    contextNamespacesstring[]
    +

    Default value opts: IReactionOptions= {}

    +

    Returns: IReactionDisposer

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Namespace): Promise‹void›

    +

    Overrides KubeObjectStore.remove

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:175

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Namespace, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Namespace

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    resetContext#

    +

    resetContext(): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:140

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Namespace): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    setContext#

    +

    setContext(namespace: string | string[]): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring | string[]
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNamespace[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Namespace[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleAll#

    +

    toggleAll(showAll?: boolean): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:162

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    showAll?boolean
    +

    Returns: void

    +
    +

    toggleContext#

    +

    toggleContext(namespace: string): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:153

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: void

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Namespace): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Namespace[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNamespace[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Namespace): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNamespace
    dataPartial‹Namespace
    +

    Returns: Promise‹Namespace

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Namespace, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Namespace

    +

    request: function

    +

    ▸ (): Promise‹Namespace

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html new file mode 100644 index 0000000000..f4127de495 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -0,0 +1,1645 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NetworkPolicy#

    +

    Hierarchy#

    + +

    NetworkPolicy

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NetworkPolicy(data: KubeJsonApiData): NetworkPolicy

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: NetworkPolicy

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    +

    Type declaration:#

    +
      +
    • +

      egress: IPolicyEgress[]

      +
    • +
    • +

      ingress: IPolicyIngress[]

      +
    • +
    • +

      podSelector(): object

      +
    • +
    • +

      matchLabels(): object

      +
        +
      • role: string
      • +
      +
    • +
    • +

      policyTypes: string[]

      +
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/networking.k8s.io/v1/networkpolicies"

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:42

    +
    +

    Static kind#

    +

    kind: string = "NetworkPolicy"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:40

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:41

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getMatchLabels#

    +

    getMatchLabels(): string[]

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTypes#

    +

    getTypes(): string[]

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html new file mode 100644 index 0000000000..e533b4641e --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicyStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NetworkPolicyStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNetworkPolicy

    +

    NetworkPolicyStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NetworkPolicyStore(): NetworkPolicyStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: NetworkPolicyStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiNetworkPolicy‹›› = networkPolicyApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: NetworkPolicy[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: NetworkPolicy[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹NetworkPolicy

    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹NetworkPolicy

    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: NetworkPolicy): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: NetworkPolicy[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNetworkPolicy[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: NetworkPolicy[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: NetworkPolicy[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): NetworkPolicy

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: NetworkPolicy

    +
    +

    getByPath#

    +

    getByPath(path: string): NetworkPolicy

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: NetworkPolicy

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: NetworkPolicy[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: NetworkPolicy[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNetworkPolicy[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: NetworkPolicy): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: NetworkPolicy[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNetworkPolicy[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | NetworkPolicy[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | NetworkPolicy[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹NetworkPolicy[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹NetworkPolicy[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: NetworkPolicy[], __namedParameters: object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: NetworkPolicy[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: NetworkPolicy[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: NetworkPolicy): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: NetworkPolicy, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: NetworkPolicy

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: NetworkPolicy[], sorting?: function[], order?: "asc" | "desc"): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNetworkPolicy[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: NetworkPolicy[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: NetworkPolicy[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNetworkPolicy[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    update#

    +

    update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    dataPartial‹NetworkPolicy
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: NetworkPolicy, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: NetworkPolicy

    +

    request: function

    +

    ▸ (): Promise‹NetworkPolicy

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html new file mode 100644 index 0000000000..63bdf967c4 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -0,0 +1,1825 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Node - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Node#

    +

    Hierarchy#

    + +

    Node

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Node(data: KubeJsonApiData): Node

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Node

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    +

    Type declaration:#

    +
      +
    • +

      externalID: string

      +
    • +
    • +

      podCIDR: string

      +
    • +
    • +

      taints? : object[]

      +
    • +
    • +

      unschedulable? : boolean

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:47

    +

    Type declaration:#

    +
      +
    • +

      addresses: object[]

      +
    • +
    • +

      allocatable(): object

      +
    • +
    • +

      cpu: string

      +
    • +
    • +

      memory: string

      +
    • +
    • +

      pods: string

      +
    • +
    • +

      capacity(): object

      +
    • +
    • +

      cpu: string

      +
    • +
    • +

      memory: string

      +
    • +
    • +

      pods: string

      +
    • +
    • +

      conditions: object[]

      +
    • +
    • +

      images: object[]

      +
    • +
    • +

      nodeInfo(): object

      +
    • +
    • +

      architecture: string

      +
    • +
    • +

      bootID: string

      +
    • +
    • +

      containerRuntimeVersion: string

      +
    • +
    • +

      kernelVersion: string

      +
    • +
    • +

      kubeProxyVersion: string

      +
    • +
    • +

      kubeletVersion: string

      +
    • +
    • +

      machineID: string

      +
    • +
    • +

      operatingSystem: string

      +
    • +
    • +

      osImage: string

      +
    • +
    • +

      systemUUID: string

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/nodes"

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:35

    +
    +

    Static kind#

    +

    kind: string = "Node"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:33

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:34

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getActiveConditions#

    +

    getActiveConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    +

    Returns: object[]

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    +

    Returns: object[]

    +
    +

    getCpuCapacity#

    +

    getCpuCapacity(): number

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getKubeletVersion#

    +

    getKubeletVersion(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getMemoryCapacity#

    +

    getMemoryCapacity(): number

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    +

    Returns: number

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeConditionText#

    +

    getNodeConditionText(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOperatingSystem#

    +

    getOperatingSystem(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRoleLabels#

    +

    getRoleLabels(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTaints#

    +

    getTaints(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    +

    Returns: object[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getWarningConditions#

    +

    getWarningConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    +

    Returns: object[]

    +
    +

    isUnschedulable#

    +

    isUnschedulable(): boolean

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html new file mode 100644 index 0000000000..2fe9725943 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -0,0 +1,1746 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: NodesApi#

    +

    Hierarchy#

    + +

    NodesApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Node
    +

    Returns: NodesApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Node

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Node

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Node

    +

    Returns: Promise‹Node

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Node

    +
    +

    getMetrics#

    +

    getMetrics(): Promise‹INodeMetrics›

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    +

    Returns: Promise‹INodeMetrics›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Node[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Node

    +

    Returns: Promise‹Node

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html new file mode 100644 index 0000000000..95f3b3aa5d --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -0,0 +1,2504 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NodesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNode

    +

    NodesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NodesStore(): NodesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: NodesStore

    +

    Properties#

    +

    api#

    +

    api: NodesApi‹› = nodesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: Partial‹INodeMetrics›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    +
    +

    metricsLoaded#

    +

    metricsLoaded: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:15

    +
    +

    metricsLoading#

    +

    metricsLoading: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    +
    +

    nodeMetrics#

    +

    nodeMetrics: Partial‹IClusterMetrics› = null

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Node[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Node[]

    +
    +

    masterNodes#

    +

    get masterNodes(): Node‹›[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:34

    +

    Returns: Node‹›[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Node[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Node[]

    +
    +

    workerNodes#

    +

    get workerNodes(): Node‹›[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:38

    +

    Returns: Node‹›[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Node

    +

    Returns: Promise‹Node

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Node

    +

    Returns: Promise‹Node

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Node): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Node[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNode[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Node[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Node[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Node[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Node[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Node

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Node

    +
    +

    getByPath#

    +

    getByPath(path: string): Node

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Node

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Node[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Node[]

    +
    +

    getLastMetricValues#

    +

    getLastMetricValues(node: Node, metricNames: string[]): number[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:42

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nodeNode
    metricNamesstring[]
    +

    Returns: number[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Node[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNode[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    getWarningsCount#

    +

    getWarningsCount(): number

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:66

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Node): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Node[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNode[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Node

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Node[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Node[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Node

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Node[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Node[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(nodeName: string): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:30

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodeNamestring
    +

    Returns: Promise‹void›

    +
    +

    loadUsageMetrics#

    +

    loadUsageMetrics(): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:18

    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Node[], __namedParameters: object): Node[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Node[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Node[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Node): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Node, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Node

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:70

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Node): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Node[], sorting?: function[], order?: "asc" | "desc"): Node[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNode[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Node[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Node): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Node[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNode[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Node): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Node, data: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNode
    dataPartial‹Node
    +

    Returns: Promise‹Node

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Node, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Node

    +

    request: function

    +

    ▸ (): Promise‹Node

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html new file mode 100644 index 0000000000..e2caa73857 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -0,0 +1,1763 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolume - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolume#

    +

    Hierarchy#

    + +

    PersistentVolume

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolume(data: KubeJsonApiData): PersistentVolume

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolume

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    +

    Type declaration:#

    +
      +
    • +

      accessModes: string[]

      +
    • +
    • +

      capacity(): object

      +
    • +
    • +

      storage: string

      +
    • +
    • +

      claimRef(): object

      +
    • +
    • +

      apiVersion: string

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      name: string

      +
    • +
    • +

      namespace: string

      +
    • +
    • +

      resourceVersion: string

      +
    • +
    • +

      uid: string

      +
    • +
    • +

      flexVolume(): object

      +
    • +
    • +

      driver: string

      +
    • +
    • +

      options(): object

      +
        +
      • +

        clusterNamespace: string

        +
      • +
      • +

        image: string

        +
      • +
      • +

        pool: string

        +
      • +
      • +

        storageClass: string

        +
      • +
      +
    • +
    • +

      mountOptions? : string[]

      +
    • +
    • +

      nfs(): object

      +
    • +
    • +

      path: string

      +
    • +
    • +

      server: string

      +
    • +
    • +

      persistentVolumeReclaimPolicy: string

      +
    • +
    • +

      storageClassName: string

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:43

    +

    Type declaration:#

    +
      +
    • +

      phase: string

      +
    • +
    • +

      reason? : string

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/persistentvolumes"

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:10

    +
    +

    Static kind#

    +

    kind: string = "PersistentVolume"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:8

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:9

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCapacity#

    +

    getCapacity(inBytes: boolean): string | number

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    inBytesbooleanfalse
    +

    Returns: string | number

    +
    +

    getClaimRefName#

    +

    getClaimRefName(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:70

    +

    Returns: string

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    +

    Returns: string

    +
    +

    getStorageClass#

    +

    getStorageClass(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    +

    Returns: string

    +
    +

    getStorageClassName#

    +

    getStorageClassName(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:74

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html new file mode 100644 index 0000000000..1d2f79de03 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -0,0 +1,1712 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaim - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumeClaim#

    +

    Hierarchy#

    + +

    PersistentVolumeClaim

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumeClaim(data: KubeJsonApiData): PersistentVolumeClaim

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolumeClaim

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    +

    Type declaration:#

    +
      +
    • +

      accessModes: string[]

      +
    • +
    • +

      resources(): object

      +
    • +
    • +

      requests(): object

      +
        +
      • storage: string
      • +
      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchExpressions: object[]

      +
    • +
    • +

      matchLabels(): object

      +
        +
      • release: string
      • +
      +
    • +
    • +

      storageClassName: string

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:49

    +

    Type declaration:#

    +
      +
    • phase: string
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/persistentvolumeclaims"

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:28

    +
    +

    Static kind#

    +

    kind: string = "PersistentVolumeClaim"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:26

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:27

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getMatchExpressions#

    +

    getMatchExpressions(): object[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    +

    Returns: object[]

    +
    +

    getMatchLabels#

    +

    getMatchLabels(): string[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPods#

    +

    getPods(allPods: Pod[]): Pod[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allPodsPod[]
    +

    Returns: Pod[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    +

    Returns: string

    +
    +

    getStorage#

    +

    getStorage(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    +

    Returns: string

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html new file mode 100644 index 0000000000..83ce0fdea2 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -0,0 +1,1765 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaimsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PersistentVolumeClaimsApi#

    +

    Hierarchy#

    + +

    PersistentVolumeClaimsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹PersistentVolumeClaim
    +

    Returns: PersistentVolumeClaimsApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹PersistentVolumeClaim

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹PersistentVolumeClaim

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    getMetrics#

    +

    getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    pvcNamestring
    namespacestring
    +

    Returns: Promise‹IPvcMetrics›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹PersistentVolumeClaim[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹PersistentVolumeClaim

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html new file mode 100644 index 0000000000..951df3c458 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -0,0 +1,2372 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumesStore#

    +

    Hierarchy#

    +

    KubeObjectStorePersistentVolume

    +

    PersistentVolumesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumesStore(): PersistentVolumesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: PersistentVolumesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiPersistentVolume‹›› = persistentVolumeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:9

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PersistentVolume[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PersistentVolume[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PersistentVolume

    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PersistentVolume

    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: PersistentVolume): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: PersistentVolume[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolume[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolume[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PersistentVolume[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): PersistentVolume

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolume

    +
    +

    getByPath#

    +

    getByPath(path: string): PersistentVolume

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolume

    +
    +

    getByStorageClass#

    +

    getByStorageClass(storageClass: StorageClass): PersistentVolume[]

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    storageClassStorageClass
    +

    Returns: PersistentVolume[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PersistentVolume[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PersistentVolume[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolume[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PersistentVolume): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PersistentVolume[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolume[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PersistentVolume[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PersistentVolume[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PersistentVolume[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹PersistentVolume[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: PersistentVolume[], __namedParameters: object): PersistentVolume[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: PersistentVolume[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PersistentVolume[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PersistentVolume): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: PersistentVolume, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: PersistentVolume

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: PersistentVolume[], sorting?: function[], order?: "asc" | "desc"): PersistentVolume[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolume[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolume[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PersistentVolume[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolume[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    update#

    +

    update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    dataPartial‹PersistentVolume
    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PersistentVolume, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PersistentVolume

    +

    request: function

    +

    ▸ (): Promise‹PersistentVolume

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html new file mode 100644 index 0000000000..f1928941df --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -0,0 +1,2163 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Pod - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Pod#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    Pod

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Pod(data: KubeJsonApiData): Pod

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Pod

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:190

    +

    Type declaration:#

    +
      +
    • +

      activeDeadlineSeconds? : number

      +
    • +
    • +

      affinity? : IAffinity

      +
    • +
    • +

      automountServiceAccountToken? : boolean

      +
    • +
    • +

      containers: IPodContainer[]

      +
    • +
    • +

      dnsPolicy? : string

      +
    • +
    • +

      hostAliases(): object

      +
    • +
    • +

      hostnames: string[]

      +
    • +
    • +

      ip: string

      +
    • +
    • +

      hostIPC? : boolean

      +
    • +
    • +

      hostNetwork? : boolean

      +
    • +
    • +

      hostPID? : boolean

      +
    • +
    • +

      hostname? : string

      +
    • +
    • +

      imagePullSecrets? : object[]

      +
    • +
    • +

      initContainers: IPodContainer[]

      +
    • +
    • +

      nodeName? : string

      +
    • +
    • +

      nodeSelector(): object

      +
    • +
    • +

      priority? : number

      +
    • +
    • +

      priorityClassName? : string

      +
    • +
    • +

      restartPolicy? : string

      +
    • +
    • +

      schedulerName? : string

      +
    • +
    • +

      securityContext(): object

      +
    • +
    • +

      serviceAccount: string

      +
    • +
    • +

      serviceAccountName: string

      +
    • +
    • +

      shareProcessNamespace? : boolean

      +
    • +
    • +

      subdomain? : string

      +
    • +
    • +

      terminationGracePeriodSeconds? : number

      +
    • +
    • +

      tolerations? : object[]

      +
    • +
    • +

      volumes? : object[]

      +
    • +
    +
    +

    Optional status#

    +

    status? : object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:247

    +

    Type declaration:#

    +
      +
    • +

      conditions: object[]

      +
    • +
    • +

      containerStatuses? : IPodContainerStatus[]

      +
    • +
    • +

      hostIP: string

      +
    • +
    • +

      initContainerStatuses? : IPodContainerStatus[]

      +
    • +
    • +

      phase: string

      +
    • +
    • +

      podIP: string

      +
    • +
    • +

      qosClass? : string

      +
    • +
    • +

      reason? : string

      +
    • +
    • +

      startTime: string

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/pods"

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:188

    +
    +

    Static kind#

    +

    kind: string = "Pod"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:186

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:187

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Overrides Deployment.getAffinity

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:390

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAllContainers#

    +

    getAllContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:272

    +

    Returns: IPodContainer[]

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:366

    +

    Returns: object[]

    +
    +

    getContainerStatuses#

    +

    getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:287

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    includeInitContainersbooleantrue
    +

    Returns: IPodContainerStatus[]

    +
    +

    getContainers#

    +

    getContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:268

    +

    Returns: IPodContainer[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getInitContainers#

    +

    getInitContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:264

    +

    Returns: IPodContainer[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getLivenessProbe#

    +

    getLivenessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:410

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeName#

    +

    getNodeName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:460

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Overrides Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:380

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPriorityClassName#

    +

    getPriorityClassName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:311

    +

    Returns: string

    +
    +

    getProbe#

    +

    getProbe(probeData: IContainerProbe): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:422

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    probeDataIContainerProbe
    +

    Returns: string[]

    +
    +

    getQosClass#

    +

    getQosClass(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:303

    +

    Returns: string

    +
    +

    getReadinessProbe#

    +

    getReadinessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:414

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getReason#

    +

    getReason(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:307

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRestartsCount#

    +

    getRestartsCount(): number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:297

    +

    Returns: number

    +
    +

    getRunningContainers#

    +

    getRunningContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:276

    +

    Returns: IPodContainer[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSecrets#

    +

    getSecrets(): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:374

    +

    Returns: string[]

    +
    +

    getSelectedNodeOs#

    +

    getSelectedNodeOs(): string | undefined

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:464

    +

    Returns: string | undefined

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getStartupProbe#

    +

    getStartupProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:418

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): PodStatus

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:315

    +

    Returns: PodStatus

    +
    +

    getStatusMessage#

    +

    getStatusMessage(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:343

    +

    Returns: string

    +
    +

    getStatusPhase#

    +

    getStatusPhase(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:362

    +

    Returns: string

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): object[]

    +

    Overrides Deployment.getTolerations

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:386

    +

    Returns: object[]

    +
    +

    getVolumes#

    +

    getVolumes(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:370

    +

    Returns: object[]

    +
    +

    hasIssues#

    +

    hasIssues(): boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:394

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html new file mode 100644 index 0000000000..d59fc2c792 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -0,0 +1,1693 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudget - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    Class: PodDisruptionBudget#

    +

    Hierarchy#

    + +

    PodDisruptionBudget

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDisruptionBudget(data: KubeJsonApiData): PodDisruptionBudget

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PodDisruptionBudget

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    +

    Type declaration:#

    +
      +
    • +

      maxUnavailable: string

      +
    • +
    • +

      minAvailable: string

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:16

    +

    Type declaration:#

    +
      +
    • +

      currentHealthy: number

      +
    • +
    • +

      desiredHealthy: number

      +
    • +
    • +

      disruptionsAllowed: number

      +
    • +
    • +

      expectedPods: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/policy/v1beta1/poddisruptionbudgets"

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:9

    +
    +

    Static kind#

    +

    kind: string = "PodDisruptionBudget"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:7

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:8

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCurrentHealthy#

    +

    getCurrentHealthy(): number

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    +

    Returns: number

    +
    +

    getDesiredHealthy#

    +

    getDesiredHealthy(): number

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getMaxUnavailable#

    +

    getMaxUnavailable(): string

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    +

    Returns: string

    +
    +

    getMinAvailable#

    +

    getMinAvailable(): string

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    +

    Returns: string

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html new file mode 100644 index 0000000000..b9788c301a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudgetsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodDisruptionBudgetsStore#

    +

    Hierarchy#

    +

    KubeObjectStorePodDisruptionBudget

    +

    PodDisruptionBudgetsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: PodDisruptionBudgetsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiPodDisruptionBudget‹›› = pdbApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PodDisruptionBudget[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PodDisruptionBudget[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PodDisruptionBudget

    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PodDisruptionBudget

    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: PodDisruptionBudget): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPodDisruptionBudget[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PodDisruptionBudget[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PodDisruptionBudget[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): PodDisruptionBudget

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PodDisruptionBudget

    +
    +

    getByPath#

    +

    getByPath(path: string): PodDisruptionBudget

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PodDisruptionBudget

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PodDisruptionBudget[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPodDisruptionBudget[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PodDisruptionBudget): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPodDisruptionBudget[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PodDisruptionBudget[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PodDisruptionBudget[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PodDisruptionBudget[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹PodDisruptionBudget[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: PodDisruptionBudget[], __namedParameters: object): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: PodDisruptionBudget[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PodDisruptionBudget[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PodDisruptionBudget): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: PodDisruptionBudget

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: PodDisruptionBudget[], sorting?: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPodDisruptionBudget[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PodDisruptionBudget[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPodDisruptionBudget[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    update#

    +

    update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    dataPartial‹PodDisruptionBudget
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PodDisruptionBudget

    +

    request: function

    +

    ▸ (): Promise‹PodDisruptionBudget

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html new file mode 100644 index 0000000000..a415f73fea --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -0,0 +1,1807 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PodsApi#

    +

    Hierarchy#

    + +

    PodsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodsApi(options: IKubeApiOptions‹Pod›): PodsApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Pod
    +

    Returns: PodsApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Pod

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Pod

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:#

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:330

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Pod

    +

    Returns: Promise‹Pod

    +
    +

    delete#

    +

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:357

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Pod

    +
    +

    getLogs#

    +

    getLogs(params: object, query?: IPodLogsQuery): Promise‹string›

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Optional query: IPodLogsQuery

    +

    Returns: Promise‹string›

    +
    +

    getMetrics#

    +

    getMetrics(pods: Pod[], namespace: string, selector: string): Promise‹IPodMetrics›

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    podsPod[]-
    namespacestring-
    selectorstring"pod, namespace"
    +

    Returns: Promise‹IPodMetrics›

    +
    +

    getResourceVersion#

    +

    getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:364

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:314

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Pod[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:447

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:348

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Pod

    +

    Returns: Promise‹Pod

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:372

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html new file mode 100644 index 0000000000..5ee6443e75 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -0,0 +1,2572 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodsStore#

    +

    Hierarchy#

    +

    KubeObjectStorePod

    +

    PodsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodsStore(): PodsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: PodsStore

    +

    Properties#

    +

    api#

    +

    api: PodsApi‹› = podsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    kubeMetrics#

    +

    kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Pod[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Pod[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Pod[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Pod[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Pod

    +

    Returns: Promise‹Pod

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Pod

    +

    Returns: Promise‹Pod

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Pod): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Pod[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPod[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Pod[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Pod[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Pod[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Pod[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Pod

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Pod

    +
    +

    getByPath#

    +

    getByPath(path: string): Pod

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Pod

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Pod[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Pod[]

    +
    +

    getPodKubeMetrics#

    +

    getPodKubeMetrics(pod: Pod): object

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: object

    +
      +
    • +

      cpu: number = 0

      +
    • +
    • +

      memory: number = 0

      +
    • +
    +
    +

    getPodsByNode#

    +

    getPodsByNode(node: string): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodestring
    +

    Returns: Pod‹›[]

    +
    +

    getPodsByOwner#

    +

    getPodsByOwner(workload: WorkloadKubeObject): Pod[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    workloadWorkloadKubeObject
    +

    Returns: Pod[]

    +
    +

    getPodsByOwnerId#

    +

    getPodsByOwnerId(workloadId: string): Pod[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    workloadIdstring
    +

    Returns: Pod[]

    +
    +

    getStatuses#

    +

    getStatuses(pods: Pod[]): Dictionary‹number›

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:59

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podsPod[]
    +

    Returns: Dictionary‹number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Pod): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Pod[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPod[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Pod

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Pod[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Pod[]›

    +
    +

    loadContainerMetrics#

    +

    loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: Promise‹IPodMetrics‹IMetrics››

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Pod

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Pod[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Pod[]›

    +
    +

    loadKubeMetrics#

    +

    loadKubeMetrics(namespace?: string): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespace?string
    +

    Returns: Promise‹void›

    +
    +

    loadMetrics#

    +

    loadMetrics(pod: Pod): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Pod[], __namedParameters: object): Pod[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Pod[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Pod[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Pod): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Pod, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Pod

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:92

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Pod): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Pod[], sorting?: function[], order?: "asc" | "desc"): Pod[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPod[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Pod[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Pod): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Pod[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPod[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Pod): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Pod, data: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPod
    dataPartial‹Pod
    +

    Returns: Promise‹Pod

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Pod, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Pod

    +

    request: function

    +

    ▸ (): Promise‹Pod

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html new file mode 100644 index 0000000000..808caf631b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -0,0 +1,1788 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: ReplicaSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    ReplicaSet

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ReplicaSet(data: KubeJsonApiData): ReplicaSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ReplicaSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:35

    +

    Type declaration:#

    +
      +
    • +

      minReadySeconds? : number

      +
    • +
    • +

      replicas? : number

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        labels(): object

        +
      • +
      • +

        app: string

        +
      • +
      +
    • +
    • +

      spec? : Pod["spec"]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:48

    +

    Type declaration:#

    +
      +
    • +

      availableReplicas? : number

      +
    • +
    • +

      conditions? : object[]

      +
    • +
    • +

      fullyLabeledReplicas? : number

      +
    • +
    • +

      observedGeneration? : number

      +
    • +
    • +

      readyReplicas? : number

      +
    • +
    • +

      replicas: number

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/apps/v1/replicasets"

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:34

    +
    +

    Static kind#

    +

    kind: string = "ReplicaSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:32

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:33

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCurrent#

    +

    getCurrent(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:68

    +

    Returns: number

    +
    +

    getDesired#

    +

    getDesired(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:64

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImages#

    +

    getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:76

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getReady#

    +

    getReady(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:72

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html new file mode 100644 index 0000000000..df0017c9ea --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -0,0 +1,2451 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ReplicaSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreReplicaSet

    +

    ReplicaSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ReplicaSetStore(): ReplicaSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ReplicaSetStore

    +

    Properties#

    +

    api#

    +

    api: ReplicaSetApi‹› = replicaSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ReplicaSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ReplicaSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ReplicaSet

    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ReplicaSet

    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: ReplicaSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: ReplicaSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsReplicaSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ReplicaSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ReplicaSet[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): ReplicaSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ReplicaSet

    +
    +

    getByPath#

    +

    getByPath(path: string): ReplicaSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ReplicaSet

    +
    +

    getChildPods#

    +

    getChildPods(replicaSet: ReplicaSet): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Pod‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ReplicaSet[]

    +
    +

    getReplicaSetsByOwner#

    +

    getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: ReplicaSet‹›[]

    +
    +

    getStatuses#

    +

    getStatuses(replicaSets: ReplicaSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetsReplicaSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ReplicaSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ReplicaSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsReplicaSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ReplicaSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ReplicaSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ReplicaSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ReplicaSet[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(replicaSet: ReplicaSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ReplicaSet[], __namedParameters: object): ReplicaSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: ReplicaSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ReplicaSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ReplicaSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: ReplicaSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: ReplicaSet

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: ReplicaSet[], sorting?: function[], order?: "asc" | "desc"): ReplicaSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsReplicaSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ReplicaSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ReplicaSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsReplicaSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    update#

    +

    update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    dataPartial‹ReplicaSet
    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ReplicaSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ReplicaSet

    +

    request: function

    +

    ▸ (): Promise‹ReplicaSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html new file mode 100644 index 0000000000..f0b4a343d8 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -0,0 +1,1632 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuota - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ResourceQuota#

    +

    Hierarchy#

    + +

    ResourceQuota

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ResourceQuota(data: KubeJsonApiData): ResourceQuota

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ResourceQuota

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    +

    Type declaration:#

    +
      +
    • +

      hard: IResourceQuotaValues

      +
    • +
    • +

      scopeSelector(): object

      +
    • +
    • +

      matchExpressions: object[]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:54

    +

    Type declaration:#

    +
      +
    • +

      hard: IResourceQuotaValues

      +
    • +
    • +

      used: IResourceQuotaValues

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/resourcequotas"

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +
    +

    Static kind#

    +

    kind: string = "ResourceQuota"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:34

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:35

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getScopeSelector#

    +

    getScopeSelector(): object[]

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html new file mode 100644 index 0000000000..e437499ad1 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuotasStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ResourceQuotasStore#

    +

    Hierarchy#

    +

    KubeObjectStoreResourceQuota

    +

    ResourceQuotasStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ResourceQuotasStore(): ResourceQuotasStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ResourceQuotasStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiResourceQuota‹›› = resourceQuotaApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ResourceQuota[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ResourceQuota[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ResourceQuota

    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ResourceQuota

    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: ResourceQuota): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: ResourceQuota[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsResourceQuota[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ResourceQuota[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ResourceQuota[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): ResourceQuota

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ResourceQuota

    +
    +

    getByPath#

    +

    getByPath(path: string): ResourceQuota

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ResourceQuota

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ResourceQuota[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ResourceQuota[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsResourceQuota[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ResourceQuota): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ResourceQuota[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsResourceQuota[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ResourceQuota[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ResourceQuota[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ResourceQuota[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ResourceQuota[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ResourceQuota[], __namedParameters: object): ResourceQuota[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: ResourceQuota[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ResourceQuota[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ResourceQuota): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: ResourceQuota, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: ResourceQuota

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: ResourceQuota[], sorting?: function[], order?: "asc" | "desc"): ResourceQuota[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsResourceQuota[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ResourceQuota[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ResourceQuota[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsResourceQuota[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    update#

    +

    update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    dataPartial‹ResourceQuota
    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ResourceQuota, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ResourceQuota

    +

    request: function

    +

    ▸ (): Promise‹ResourceQuota

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html new file mode 100644 index 0000000000..bfb2126ed3 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -0,0 +1,1612 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Role - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Role#

    +

    Hierarchy#

    + +

    Role

    +

    ClusterRole

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Role(data: KubeJsonApiData): Role

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Role

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    rules#

    +

    rules: object[]

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

    +

    Defined in src/renderer/api/endpoints/role.api.ts:7

    +
    +

    Static kind#

    +

    kind: string = "Role"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/role.api.ts:5

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/role.api.ts:6

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRules#

    +

    getRules(): object[]

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html new file mode 100644 index 0000000000..62d863458b --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -0,0 +1,1649 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RoleBinding#

    +

    Hierarchy#

    + +

    RoleBinding

    +

    ClusterRoleBinding

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RoleBinding(data: KubeJsonApiData): RoleBinding

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: RoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    roleRef#

    +

    roleRef: object

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Type declaration:#

    +
      +
    • +

      apiGroup? : string

      +
    • +
    • +

      kind: string

      +
    • +
    • +

      name: string

      +
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Optional subjects#

    +

    subjects? : IRoleBindingSubject[]

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:18

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/rbac.authorization.k8s.io/v1/rolebindings"

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:16

    +
    +

    Static kind#

    +

    kind: string = "RoleBinding"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:14

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:15

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSubjectNames#

    +

    getSubjectNames(): string

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Returns: string

    +
    +

    getSubjects#

    +

    getSubjects(): IRoleBindingSubject[]

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Returns: IRoleBindingSubject[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html new file mode 100644 index 0000000000..043d32faa1 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -0,0 +1,2361 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBindingsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RoleBindingsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreRoleBinding

    +

    RoleBindingsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RoleBindingsStore(): RoleBindingsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: RoleBindingsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiClusterRoleBinding‹›› = clusterRoleBindingApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: RoleBinding[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: RoleBinding[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹RoleBinding

    +

    Returns: Promise‹RoleBinding

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:38

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹RoleBinding

    +

    Returns: Promise‹RoleBinding‹››

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: RoleBinding): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: RoleBinding[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: RoleBinding[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): RoleBinding[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: RoleBinding[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): RoleBinding

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: RoleBinding

    +
    +

    getByPath#

    +

    getByPath(path: string): RoleBinding

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: RoleBinding

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: RoleBinding[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: RoleBinding[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApiRoleBinding‹››[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    +

    Returns: KubeApiRoleBinding‹››[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: RoleBinding): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: RoleBinding[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRoleBinding[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹RoleBinding

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹RoleBinding

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | RoleBinding[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | RoleBinding[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹RoleBinding‹››

    +

    Overrides KubeObjectStore.loadItem

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹RoleBinding‹››

    +
    +

    Protected loadItems#

    +

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹RoleBinding[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹RoleBinding[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: RoleBinding[], __namedParameters: object): RoleBinding[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: RoleBinding[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: RoleBinding[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: RoleBinding): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: RoleBinding, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: RoleBinding

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: RoleBinding[]): RoleBinding‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: RoleBinding‹›[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: RoleBinding[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRoleBinding[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    update#

    +

    update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    dataPartial‹RoleBinding
    +

    Returns: Promise‹RoleBinding

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: RoleBinding, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: RoleBinding

    +

    request: function

    +

    ▸ (): Promise‹RoleBinding

    +

    Returns: Promise‹T›

    +
    +

    updateSubjects#

    +

    updateSubjects(params: object): Promise‹RoleBinding‹››

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:46

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    addSubjects?IRoleBindingSubject[]
    removeSubjects?IRoleBindingSubject[]
    roleBindingRoleBinding
    +

    Returns: Promise‹RoleBinding‹››

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html new file mode 100644 index 0000000000..5d81a4bae6 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -0,0 +1,2324 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RolesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RolesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreRole

    +

    RolesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RolesStore(): RolesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: RolesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiClusterRole‹›› = clusterRoleApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Role[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Role[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Role[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Role[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Role›): Promise‹Role

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Role

    +

    Returns: Promise‹Role

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:36

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Role

    +

    Returns: Promise‹Role‹››

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Role): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Role[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Role[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Role[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Role[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Role[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Role

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Role

    +
    +

    getByPath#

    +

    getByPath(path: string): Role

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Role

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Role[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Role[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Role[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApiRole‹››[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    +

    Returns: KubeApiRole‹››[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Role): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Role[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRole[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Role

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Role

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Role[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Role[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Role‹››

    +

    Overrides KubeObjectStore.loadItem

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Role‹››

    +
    +

    Protected loadItems#

    +

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Role[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹Role[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Role[], __namedParameters: object): Role[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Role[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Role[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Role): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Role, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Role

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Role): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Role[]): Role‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: Role‹›[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Role): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Role[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRole[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Role): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Role, data: Partial‹Role›): Promise‹Role

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRole
    dataPartial‹Role
    +

    Returns: Promise‹Role

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Role, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Role

    +

    request: function

    +

    ▸ (): Promise‹Role

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html new file mode 100644 index 0000000000..2d46fd1beb --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -0,0 +1,1645 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Secret - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Secret#

    +

    Hierarchy#

    + +

    Secret

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Secret(data: KubeJsonApiData): Secret

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Secret

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    data#

    +

    data: object

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    +

    Type declaration:#

    +
      +
    • +

      [ prop: string]: string

      +
    • +
    • +

      token? : string

      +
    • +
    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    type#

    +

    type: SecretType

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:28

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/secrets"

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:26

    +
    +

    Static kind#

    +

    kind: string = "Secret"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:24

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:25

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getKeys#

    +

    getKeys(): string[]

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getToken#

    +

    getToken(): string

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    +

    Returns: string

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html new file mode 100644 index 0000000000..77eb91ff14 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: SecretsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: SecretsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreSecret

    +

    SecretsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new SecretsStore(): SecretsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: SecretsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiSecret‹›› = secretsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Secret[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Secret[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Secret[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Secret[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Secret›): Promise‹Secret

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Secret

    +

    Returns: Promise‹Secret

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Secret›): Promise‹Secret

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Secret

    +

    Returns: Promise‹Secret

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Secret): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Secret[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsSecret[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Secret[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Secret[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Secret[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Secret[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Secret

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Secret

    +
    +

    getByPath#

    +

    getByPath(path: string): Secret

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Secret

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Secret[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Secret[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Secret[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsSecret[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Secret): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Secret[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsSecret[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Secret

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Secret[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Secret[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Secret

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Secret[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Secret[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Secret[], __namedParameters: object): Secret[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Secret[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Secret[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Secret): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Secret, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Secret

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Secret): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Secret[], sorting?: function[], order?: "asc" | "desc"): Secret[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsSecret[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Secret[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Secret): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Secret[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsSecret[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Secret): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Secret, data: Partial‹Secret›): Promise‹Secret

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemSecret
    dataPartial‹Secret
    +

    Returns: Promise‹Secret

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Secret, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Secret

    +

    request: function

    +

    ▸ (): Promise‹Secret

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html new file mode 100644 index 0000000000..98f8d9e196 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -0,0 +1,1741 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Service - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Service#

    +

    Hierarchy#

    + +

    Service

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Service(data: KubeJsonApiData): Service

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Service

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/service.api.ts:38

    +

    Type declaration:#

    +
      +
    • +

      clusterIP: string

      +
    • +
    • +

      externalIPs? : string[]

      +
    • +
    • +

      externalTrafficPolicy? : string

      +
    • +
    • +

      loadBalancerIP? : string

      +
    • +
    • +

      ports: ServicePort[]

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      sessionAffinity: string

      +
    • +
    • +

      type: string

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/service.api.ts:49

    +

    Type declaration:#

    +
      +
    • +

      loadBalancer(): object

      +
    • +
    • +

      ingress? : object[]

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/services"

    +

    Defined in src/renderer/api/endpoints/service.api.ts:36

    +
    +

    Static kind#

    +

    kind: string = "Service"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/service.api.ts:34

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/service.api.ts:35

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getClusterIp#

    +

    getClusterIp(): string

    +

    Defined in src/renderer/api/endpoints/service.api.ts:58

    +

    Returns: string

    +
    +

    getExternalIps#

    +

    getExternalIps(): string[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:62

    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getLoadBalancer#

    +

    getLoadBalancer(): object

    +

    Defined in src/renderer/api/endpoints/service.api.ts:88

    +

    Returns: object

    +
      +
    • ingress? : object[]
    • +
    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getPorts#

    +

    getPorts(): ServicePort[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:82

    +

    Returns: ServicePort[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelector#

    +

    getSelector(): string[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:76

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): "Active" | "Pending"

    +

    Defined in src/renderer/api/endpoints/service.api.ts:96

    +

    Returns: "Active" | "Pending"

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getType#

    +

    getType(): string

    +

    Defined in src/renderer/api/endpoints/service.api.ts:72

    +

    Returns: string

    +
    +

    isActive#

    +

    isActive(): boolean

    +

    Defined in src/renderer/api/endpoints/service.api.ts:92

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html new file mode 100644 index 0000000000..351e5b3aa4 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -0,0 +1,1636 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccount - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: ServiceAccount#

    +

    Hierarchy#

    + +

    ServiceAccount

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceAccount(data: KubeJsonApiData): ServiceAccount

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ServiceAccount

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    Optional imagePullSecrets#

    +

    imagePullSecrets? : object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional secrets#

    +

    secrets? : object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/serviceaccounts"

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

    +
    +

    Static kind#

    +

    kind: string = "ServiceAccount"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImagePullSecrets#

    +

    getImagePullSecrets(): object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    +

    Returns: object[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSecrets#

    +

    getSecrets(): object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    +

    Returns: object[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html new file mode 100644 index 0000000000..bed897ed82 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -0,0 +1,2342 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccountsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceAccountsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreServiceAccount

    +

    ServiceAccountsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceAccountsStore(): ServiceAccountsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ServiceAccountsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiServiceAccount‹›› = serviceAccountsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ServiceAccount[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ServiceAccount[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹ServiceAccount

    +

    Returns: Promise‹ServiceAccount

    +
    +

    Protected createItem#

    +

    createItem(params: object): Promise‹ServiceAccount‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount‹››

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: ServiceAccount): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: ServiceAccount[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsServiceAccount[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ServiceAccount[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ServiceAccount[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): ServiceAccount

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ServiceAccount

    +
    +

    getByPath#

    +

    getByPath(path: string): ServiceAccount

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ServiceAccount

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ServiceAccount[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ServiceAccount[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsServiceAccount[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ServiceAccount): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ServiceAccount[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsServiceAccount[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹ServiceAccount

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ServiceAccount[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ServiceAccount[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹ServiceAccount

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ServiceAccount[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ServiceAccount[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ServiceAccount[], __namedParameters: object): ServiceAccount[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: ServiceAccount[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ServiceAccount[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ServiceAccount): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: ServiceAccount, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: ServiceAccount

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: ServiceAccount[], sorting?: function[], order?: "asc" | "desc"): ServiceAccount[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsServiceAccount[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ServiceAccount[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ServiceAccount[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsServiceAccount[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    update#

    +

    update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    dataPartial‹ServiceAccount
    +

    Returns: Promise‹ServiceAccount

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ServiceAccount, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ServiceAccount

    +

    request: function

    +

    ▸ (): Promise‹ServiceAccount

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html new file mode 100644 index 0000000000..3524ca860a --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceStore#

    +

    Hierarchy#

    +

    KubeObjectStoreService

    +

    ServiceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceStore(): ServiceStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ServiceStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiService‹›› = serviceApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-services/services.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Service[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Service[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): Service[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Service[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Service›): Promise‹Service

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Service

    +

    Returns: Promise‹Service

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹Service›): Promise‹Service

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹Service

    +

    Returns: Promise‹Service

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: Service): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: Service[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsService[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): Service[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Service[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Service[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Service[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): Service

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Service

    +
    +

    getByPath#

    +

    getByPath(path: string): Service

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Service

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Service[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Service[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Service[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsService[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Service): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Service[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsService[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹Service

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Service[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Service[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹Service

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Service[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Service[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Service[], __namedParameters: object): Service[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: Service[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Service[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Service): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: Service, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: Service

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Service): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Service[], sorting?: function[], order?: "asc" | "desc"): Service[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsService[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Service[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Service): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Service[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsService[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Service): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    update#

    +

    update(item: Service, data: Partial‹Service›): Promise‹Service

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemService
    dataPartial‹Service
    +

    Returns: Promise‹Service

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Service, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Service

    +

    request: function

    +

    ▸ (): Promise‹Service

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html new file mode 100644 index 0000000000..afeaa06ae0 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -0,0 +1,1782 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: StatefulSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
    • +
    +

    StatefulSet

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatefulSet(data: KubeJsonApiData): StatefulSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StatefulSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    +

    Type declaration:#

    +
      +
    • +

      replicas: number

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      serviceName: string

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        labels(): object

        +
      • +
      • +

        app: string

        +
      • +
      +
    • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
      • +
      • +

        containers: object[]

        +
      • +
      • +

        nodeSelector(): object

        +
      • +
      • +

        tolerations: object[]

        +
      • +
      +
    • +
    • +

      volumeClaimTemplates: object[]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:89

    +

    Type declaration:#

    +
      +
    • +

      collisionCount: number

      +
    • +
    • +

      currentReplicas: number

      +
    • +
    • +

      currentRevision: string

      +
    • +
    • +

      observedGeneration: number

      +
    • +
    • +

      readyReplicas: number

      +
    • +
    • +

      replicas: number

      +
    • +
    • +

      updateRevision: string

      +
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/apps/v1/statefulsets"

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:34

    +
    +

    Static kind#

    +

    kind: string = "StatefulSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:32

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:33

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImages#

    +

    getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getTolerations#

    +

    getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html new file mode 100644 index 0000000000..a14ab83f11 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -0,0 +1,2423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StatefulSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreStatefulSet

    +

    StatefulSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatefulSetStore(): StatefulSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: StatefulSetStore

    +

    Properties#

    +

    api#

    +

    api: StatefulSetApi‹› = statefulSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: StatefulSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: StatefulSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹StatefulSet

    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹StatefulSet

    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: StatefulSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: StatefulSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStatefulSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StatefulSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): StatefulSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: StatefulSet[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): StatefulSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StatefulSet

    +
    +

    getByPath#

    +

    getByPath(path: string): StatefulSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: StatefulSet

    +
    +

    getChildPods#

    +

    getChildPods(statefulSet: StatefulSet): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetStatefulSet
    +

    Returns: Pod‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: StatefulSet[]

    +
    +

    getStatuses#

    +

    getStatuses(statefulSets: StatefulSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetsStatefulSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: StatefulSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: StatefulSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStatefulSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | StatefulSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | StatefulSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹StatefulSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹StatefulSet[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(statefulSet: StatefulSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetStatefulSet
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: StatefulSet[], __namedParameters: object): StatefulSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: StatefulSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: StatefulSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: StatefulSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: StatefulSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: StatefulSet

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: StatefulSet[], sorting?: function[], order?: "asc" | "desc"): StatefulSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStatefulSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StatefulSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: StatefulSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStatefulSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    update#

    +

    update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    dataPartial‹StatefulSet
    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: StatefulSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: StatefulSet

    +

    request: function

    +

    ▸ (): Promise‹StatefulSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html new file mode 100644 index 0000000000..b3db8388b4 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -0,0 +1,1689 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClass - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: StorageClass#

    +

    Hierarchy#

    + +

    StorageClass

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StorageClass(data: KubeJsonApiData): StorageClass

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StorageClass

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional mountOptions#

    +

    mountOptions? : string[]

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12

    +
    +

    parameters#

    +

    parameters: object

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    +

    Type declaration:#

    +
      +
    • [ param: string]: string
    • +
    +
    +

    provisioner#

    +

    provisioner: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:11

    +
    +

    reclaimPolicy#

    +

    reclaimPolicy: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:14

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    volumeBindingMode#

    +

    volumeBindingMode: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:13

    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/storage.k8s.io/v1/storageclasses"

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:9

    +
    +

    Static kind#

    +

    kind: string = "StorageClass"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:7

    +
    +

    Static namespaced#

    +

    namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:8

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:193

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:129

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:150

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:142

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:146

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Returns: object[]

    +
    +

    getReclaimPolicy#

    +

    getReclaimPolicy(): string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:169

    +

    Returns: string[]

    +
    +

    getTimeDiffFromNow#

    +

    getTimeDiffFromNow(): number

    +

    Inherited from KubeObject.getTimeDiffFromNow

    +

    Defined in src/renderer/api/kube-object.ts:125

    +

    Returns: number

    +
    +

    getVolumeBindingMode#

    +

    getVolumeBindingMode(): string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    +

    Returns: string

    +
    +

    isDefault#

    +

    isDefault(): boolean

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:181

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:186

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html new file mode 100644 index 0000000000..d735804d22 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -0,0 +1,2372 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClassStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StorageClassStore#

    +

    Hierarchy#

    +

    KubeObjectStoreStorageClass

    +

    StorageClassStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StorageClassStore(): StorageClassStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: StorageClassStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiStorageClass‹›› = storageClassApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:9

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: StorageClass[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: StorageClass[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹StorageClass

    +

    Returns: Promise‹StorageClass

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹StorageClass

    +

    Returns: Promise‹StorageClass

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: StorageClass): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: StorageClass[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStorageClass[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StorageClass[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): StorageClass[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: StorageClass[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): StorageClass

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StorageClass

    +
    +

    getByPath#

    +

    getByPath(path: string): StorageClass

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: StorageClass

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: StorageClass[]

    +
    +

    getPersistentVolumes#

    +

    getPersistentVolumes(storageClass: StorageClass): PersistentVolume‹›[]

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    storageClassStorageClass
    +

    Returns: PersistentVolume‹›[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: StorageClass[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStorageClass[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: StorageClass): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: StorageClass[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStorageClass[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | StorageClass[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | StorageClass[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹StorageClass[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹StorageClass[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: StorageClass[], __namedParameters: object): StorageClass[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: StorageClass[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: StorageClass[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: StorageClass): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: StorageClass, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: StorageClass

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: StorageClass): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: StorageClass[], sorting?: function[], order?: "asc" | "desc"): StorageClass[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStorageClass[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StorageClass[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: StorageClass): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: StorageClass[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStorageClass[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: StorageClass): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    update#

    +

    update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    dataPartial‹StorageClass
    +

    Returns: Promise‹StorageClass

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: StorageClass, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: StorageClass

    +

    request: function

    +

    ▸ (): Promise‹StorageClass

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html new file mode 100644 index 0000000000..45a01f9436 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -0,0 +1,2384 @@ + + + + + + + + + + + + + + + + + + + + + + Class: VolumeClaimStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: VolumeClaimStore#

    +

    Hierarchy#

    +

    KubeObjectStorePersistentVolumeClaim

    +

    VolumeClaimStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new VolumeClaimStore(): VolumeClaimStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: VolumeClaimStore

    +

    Properties#

    +

    api#

    +

    api: PersistentVolumeClaimsApi‹› = pvcApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:261

    +
    +

    isLoaded#

    +

    isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:22

    +
    +

    metrics#

    +

    metrics: IPvcMetrics = null

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PersistentVolumeClaim[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PersistentVolumeClaim[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:263

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:232

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PersistentVolumeClaim

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:228

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹PersistentVolumeClaim

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: PersistentVolumeClaim): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:132

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolumeClaim[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolumeClaim

    +
    +

    getByPath#

    +

    getByPath(path: string): PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolumeClaim

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PersistentVolumeClaim[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolumeClaim[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:269

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PersistentVolumeClaim): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolumeClaim[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:207

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PersistentVolumeClaim[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:137

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PersistentVolumeClaim[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:222

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:202

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PersistentVolumeClaim[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹PersistentVolumeClaim[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pvcPersistentVolumeClaim
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: PersistentVolumeClaim[], __namedParameters: object): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:178

    +

    Parameters:

    +

    partialItems: PersistentVolumeClaim[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PersistentVolumeClaim): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:250

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: PersistentVolumeClaim

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:256

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: PersistentVolumeClaim[], sorting?: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolumeClaim[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:273

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolumeClaim[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    update#

    +

    update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:241

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    dataPartial‹PersistentVolumeClaim
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:351

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PersistentVolumeClaim

    +

    request: function

    +

    ▸ (): Promise‹PersistentVolumeClaim

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/v4.2.1/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html new file mode 100644 index 0000000000..8158ec1a54 --- /dev/null +++ b/v4.2.1/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -0,0 +1,1376 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PageParam ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PageParam ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParam
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PageParam(init: PageParamInit‹V› | PageSystemParamInit‹V›, history: IObservableHistory): PageParam

    +

    Defined in src/renderer/navigation/page-param.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    initPageParamInit‹V› | PageSystemParamInit‹V›
    historyIObservableHistory
    +

    Returns: PageParam

    +

    Properties#

    +

    Protected history#

    +

    history: IObservableHistory

    +

    Defined in src/renderer/navigation/page-param.ts:25

    +
    +

    init#

    +

    init: PageParamInit‹V› | PageSystemParamInit‹V›

    +

    Defined in src/renderer/navigation/page-param.ts:25

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/navigation/page-param.ts:22

    +
    +

    urlName#

    +

    urlName: string

    +

    Defined in src/renderer/navigation/page-param.ts:23

    +
    +

    Static SYSTEM_PREFIX#

    +

    SYSTEM_PREFIX: string = "lens-"

    +

    Defined in src/renderer/navigation/page-param.ts:20

    +

    Methods#

    +

    clear#

    +

    clear(): void

    +

    Defined in src/renderer/navigation/page-param.ts:107

    +

    Returns: void

    +
    +

    get#

    +

    get(): V

    +

    Defined in src/renderer/navigation/page-param.ts:66

    +

    Returns: V

    +
    +

    getDefaultValue#

    +

    getDefaultValue(): V

    +

    Defined in src/renderer/navigation/page-param.ts:101

    +

    Returns: V

    +
    +

    getRaw#

    +

    getRaw(): string[]

    +

    Defined in src/renderer/navigation/page-param.ts:94

    +

    Returns: string[]

    +
    +

    isEmpty#

    +

    isEmpty(value: V | any): boolean

    +

    Defined in src/renderer/navigation/page-param.ts:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueV | any
    +

    Returns: boolean

    +
    +

    parse#

    +

    parse(values: string[]): V

    +

    Defined in src/renderer/navigation/page-param.ts:40

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuesstring[]
    +

    Returns: V

    +
    +

    set#

    +

    set(value: V, __namedParameters: object): void

    +

    Defined in src/renderer/navigation/page-param.ts:76

    +

    Parameters:

    +

    value: V

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    mergeGlobalsbooleantrue
    replaceHistorybooleanfalse
    +

    Returns: void

    +
    +

    setRaw#

    +

    setRaw(value: string | string[]): void

    +

    Defined in src/renderer/navigation/page-param.ts:82

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring | string[]
    +

    Returns: void

    +
    +

    stringify#

    +

    stringify(value: V): string

    +

    Defined in src/renderer/navigation/page-param.ts:49

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valueVthis.get()
    +

    Returns: string

    +
    +

    toObjectParam#

    +

    toObjectParam(value: V): Record‹string, V›

    +

    Defined in src/renderer/navigation/page-param.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valueVthis.get()
    +

    Returns: Record‹string, V›

    +
    +

    toSearchString#

    +

    toSearchString(__namedParameters: object): string

    +

    Defined in src/renderer/navigation/page-param.ts:111

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    mergeGlobalsbooleantrue
    valueVthis.get()
    withPrefixbooleantrue
    +

    Returns: string

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/lensmainextension/index.html b/v4.2.1/extensions/api/classes/lensmainextension/index.html new file mode 100644 index 0000000000..9559160ebe --- /dev/null +++ b/v4.2.1/extensions/api/classes/lensmainextension/index.html @@ -0,0 +1,1344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensMainExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LensMainExtension#

    +

    Hierarchy#

    +
      +
    • LensExtension
    • +
    +

    LensMainExtension

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LensMainExtension(__namedParameters: object): LensMainExtension

    +

    Inherited from LensMainExtension.constructor

    +

    Defined in src/extensions/lens-extension.ts:27

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    isBundledboolean
    manifestLensExtensionManifest
    manifestPathstring
    +

    Returns: LensMainExtension

    +

    Properties#

    +

    appMenus#

    +

    appMenus: MenuRegistration[] = []

    +

    Defined in src/extensions/lens-main-extension.ts:7

    +
    +

    id#

    +

    id: LensExtensionId

    +

    Inherited from LensMainExtension.id

    +

    Defined in src/extensions/lens-extension.ts:20

    +
    +

    isBundled#

    +

    isBundled: boolean

    +

    Inherited from LensMainExtension.isBundled

    +

    Defined in src/extensions/lens-extension.ts:23

    +
    +

    manifest#

    +

    manifest: LensExtensionManifest

    +

    Inherited from LensMainExtension.manifest

    +

    Defined in src/extensions/lens-extension.ts:21

    +
    +

    manifestPath#

    +

    manifestPath: string

    +

    Inherited from LensMainExtension.manifestPath

    +

    Defined in src/extensions/lens-extension.ts:22

    +
    +

    protocolHandlers#

    +

    protocolHandlers: ProtocolHandlerRegistration[] = []

    +

    Inherited from LensMainExtension.protocolHandlers

    +

    Defined in src/extensions/lens-extension.ts:25

    +

    Accessors#

    +

    description#

    +

    get description(): string

    +

    Inherited from LensMainExtension.description

    +

    Defined in src/extensions/lens-extension.ts:55

    +

    Returns: string

    +
    +

    name#

    +

    get name(): string

    +

    Inherited from LensMainExtension.name

    +

    Defined in src/extensions/lens-extension.ts:36

    +

    Returns: string

    +
    +

    version#

    +

    get version(): string

    +

    Inherited from LensMainExtension.version

    +

    Defined in src/extensions/lens-extension.ts:40

    +

    Returns: string

    +

    Methods#

    +

    disable#

    +

    disable(): Promise‹void›

    +

    Inherited from LensMainExtension.disable

    +

    Defined in src/extensions/lens-extension.ts:68

    +

    Returns: Promise‹void›

    +
    +

    enable#

    +

    enable(): Promise‹void›

    +

    Inherited from LensMainExtension.enable

    +

    Defined in src/extensions/lens-extension.ts:60

    +

    Returns: Promise‹void›

    +
    +

    getExtensionFileFolder#

    +

    getExtensionFileFolder(): Promise‹string›

    +

    Inherited from LensMainExtension.getExtensionFileFolder

    +

    Defined in src/extensions/lens-extension.ts:51

    +

    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 obfiscation of the +folder name.

    +

    Returns: Promise‹string›

    +
    + +

    navigateP›(pageId?: string, params?: P, frameId?: number): Promise‹void›

    +

    Defined in src/extensions/lens-main-extension.ts:9

    +

    Type parameters:

    +

    P: object

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    pageId?string
    params?P
    frameId?number
    +

    Returns: Promise‹void›

    +
    +

    Protected onActivate#

    +

    onActivate(): void

    +

    Inherited from LensMainExtension.onActivate

    +

    Defined in src/extensions/lens-extension.ts:107

    +

    Returns: void

    +
    +

    Protected onDeactivate#

    +

    onDeactivate(): void

    +

    Inherited from LensMainExtension.onDeactivate

    +

    Defined in src/extensions/lens-extension.ts:111

    +

    Returns: void

    +
    +

    toggle#

    +

    toggle(enable?: boolean): void

    +

    Inherited from LensMainExtension.toggle

    +

    Defined in src/extensions/lens-extension.ts:75

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enable?boolean
    +

    Returns: void

    +
    +

    whenEnabled#

    +

    whenEnabled(handlers: function): Promise‹(Anonymous function)›

    +

    Inherited from LensMainExtension.whenEnabled

    +

    Defined in src/extensions/lens-extension.ts:83

    +

    Parameters:

    +

    handlers: function

    +

    ▸ (): Promise‹Function[]›

    +

    Returns: Promise‹(Anonymous function)›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/classes/lensrendererextension/index.html b/v4.2.1/extensions/api/classes/lensrendererextension/index.html new file mode 100644 index 0000000000..06d47d5c1e --- /dev/null +++ b/v4.2.1/extensions/api/classes/lensrendererextension/index.html @@ -0,0 +1,1489 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensRendererExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LensRendererExtension#

    +

    Hierarchy#

    +
      +
    • LensExtension
    • +
    +

    LensRendererExtension

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LensRendererExtension(__namedParameters: object): LensRendererExtension

    +

    Inherited from LensMainExtension.constructor

    +

    Defined in src/extensions/lens-extension.ts:27

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    isBundledboolean
    manifestLensExtensionManifest
    manifestPathstring
    +

    Returns: LensRendererExtension

    +

    Properties#

    +

    appPreferences#

    +

    appPreferences: AppPreferenceRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:13

    +
    +

    clusterFeatures#

    +

    clusterFeatures: ClusterFeatureRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:14

    +
    +

    clusterPageMenus#

    +

    clusterPageMenus: ClusterPageMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:11

    +
    +

    clusterPages#

    +

    clusterPages: PageRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:9

    +
    +

    commands#

    +

    commands: CommandRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:18

    +
    +

    globalPageMenus#

    +

    globalPageMenus: PageMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:10

    +
    +

    globalPages#

    +

    globalPages: PageRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:8

    +
    +

    id#

    +

    id: LensExtensionId

    +

    Inherited from LensMainExtension.id

    +

    Defined in src/extensions/lens-extension.ts:20

    +
    +

    isBundled#

    +

    isBundled: boolean

    +

    Inherited from LensMainExtension.isBundled

    +

    Defined in src/extensions/lens-extension.ts:23

    +
    +

    kubeObjectDetailItems#

    +

    kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:16

    +
    +

    kubeObjectMenuItems#

    +

    kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:17

    +
    +

    kubeObjectStatusTexts#

    +

    kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:12

    +
    +

    manifest#

    +

    manifest: LensExtensionManifest

    +

    Inherited from LensMainExtension.manifest

    +

    Defined in src/extensions/lens-extension.ts:21

    +
    +

    manifestPath#

    +

    manifestPath: string

    +

    Inherited from LensMainExtension.manifestPath

    +

    Defined in src/extensions/lens-extension.ts:22

    +
    +

    protocolHandlers#

    +

    protocolHandlers: ProtocolHandlerRegistration[] = []

    +

    Inherited from LensMainExtension.protocolHandlers

    +

    Defined in src/extensions/lens-extension.ts:25

    +
    +

    statusBarItems#

    +

    statusBarItems: StatusBarRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:15

    +

    Accessors#

    +

    description#

    +

    get description(): string

    +

    Inherited from LensMainExtension.description

    +

    Defined in src/extensions/lens-extension.ts:55

    +

    Returns: string

    +
    +

    name#

    +

    get name(): string

    +

    Inherited from LensMainExtension.name

    +

    Defined in src/extensions/lens-extension.ts:36

    +

    Returns: string

    +
    +

    version#

    +

    get version(): string

    +

    Inherited from LensMainExtension.version

    +

    Defined in src/extensions/lens-extension.ts:40

    +

    Returns: string

    +

    Methods#

    +

    disable#

    +

    disable(): Promise‹void›

    +

    Inherited from LensMainExtension.disable

    +

    Defined in src/extensions/lens-extension.ts:68

    +

    Returns: Promise‹void›

    +
    +

    enable#

    +

    enable(): Promise‹void›

    +

    Inherited from LensMainExtension.enable

    +

    Defined in src/extensions/lens-extension.ts:60

    +

    Returns: Promise‹void›

    +
    +

    getExtensionFileFolder#

    +

    getExtensionFileFolder(): Promise‹string›

    +

    Inherited from LensMainExtension.getExtensionFileFolder

    +

    Defined in src/extensions/lens-extension.ts:51

    +

    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 obfiscation of the +folder name.

    +

    Returns: Promise‹string›

    +
    +

    isEnabledForCluster#

    +

    isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

    +

    Defined in src/extensions/lens-renderer-extension.ts:34

    +

    Defines if extension is enabled for a given cluster. Defaults to true.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    clusterCluster
    +

    Returns: Promise‹Boolean›

    +
    + +

    navigateP›(pageId?: string, params?: P): Promise‹void›

    +

    Defined in src/extensions/lens-renderer-extension.ts:20

    +

    Type parameters:

    +

    P: object

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    pageId?string
    params?P
    +

    Returns: Promise‹void›

    +
    +

    Protected onActivate#

    +

    onActivate(): void

    +

    Inherited from LensMainExtension.onActivate

    +

    Defined in src/extensions/lens-extension.ts:107

    +

    Returns: void

    +
    +

    Protected onDeactivate#

    +

    onDeactivate(): void

    +

    Inherited from LensMainExtension.onDeactivate

    +

    Defined in src/extensions/lens-extension.ts:111

    +

    Returns: void

    +
    +

    toggle#

    +

    toggle(enable?: boolean): void

    +

    Inherited from LensMainExtension.toggle

    +

    Defined in src/extensions/lens-extension.ts:75

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enable?boolean
    +

    Returns: void

    +
    +

    whenEnabled#

    +

    whenEnabled(handlers: function): Promise‹(Anonymous function)›

    +

    Inherited from LensMainExtension.whenEnabled

    +

    Defined in src/extensions/lens-extension.ts:83

    +

    Parameters:

    +

    handlers: function

    +

    ▸ (): Promise‹Function[]›

    +

    Returns: Promise‹(Anonymous function)›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/v4.2.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html new file mode 100644 index 0000000000..c1c6545c98 --- /dev/null +++ b/v4.2.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: NotificationStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/v4.2.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html new file mode 100644 index 0000000000..f9fb337cd1 --- /dev/null +++ b/v4.2.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -0,0 +1,1040 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: TooltipPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Enumeration: TooltipPosition#

    +

    Index#

    +

    Enumeration members#

    + +

    Enumeration members#

    +

    BOTTOM#

    +

    BOTTOM: = "bottom"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:11

    +
    +

    BOTTOM_LEFT#

    +

    BOTTOM_LEFT: = "bottom_left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:16

    +
    +

    BOTTOM_RIGHT#

    +

    BOTTOM_RIGHT: = "bottom_right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:17

    +
    +

    LEFT#

    +

    LEFT: = "left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:12

    +
    + +

    RIGHT: = "right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:13

    +
    +

    TOP#

    +

    TOP: = "top"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:10

    +
    +

    TOP_LEFT#

    +

    TOP_LEFT: = "top_left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:14

    +
    +

    TOP_RIGHT#

    +

    TOP_RIGHT: = "top_right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:15

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/v4.2.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html new file mode 100644 index 0000000000..f409a079bf --- /dev/null +++ b/v4.2.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: KubeObjectStatusLevel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/globals/index.html b/v4.2.1/extensions/api/globals/index.html new file mode 100644 index 0000000000..b0acd8578c --- /dev/null +++ b/v4.2.1/extensions/api/globals/index.html @@ -0,0 +1,953 @@ + + + + + + + + + + + + + + + + + + + + + + @k8slens/extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + + +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/index.html b/v4.2.1/extensions/api/index.html new file mode 100644 index 0000000000..a8f6cfc9fc --- /dev/null +++ b/v4.2.1/extensions/api/index.html @@ -0,0 +1,947 @@ + + + + + + + + + + + + + + + + + + + + + + API Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/v4.2.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html new file mode 100644 index 0000000000..df7ae40733 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterFeatureStatus#

    +

    Hierarchy#

    +
      +
    • ClusterFeatureStatus
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    canUpgrade#

    +

    canUpgrade: boolean

    +

    Defined in src/extensions/cluster-feature.ts:20

    +

    whether the feature can be upgraded or not, as set by the implementation

    +
    +

    currentVersion#

    +

    currentVersion: string

    +

    Defined in src/extensions/cluster-feature.ts:14

    +

    feature's current version, as set by the implementation

    +
    +

    installed#

    +

    installed: boolean

    +

    Defined in src/extensions/cluster-feature.ts:18

    +

    whether the feature is installed or not, as set by the implementation

    +
    +

    latestVersion#

    +

    latestVersion: string

    +

    Defined in src/extensions/cluster-feature.ts:16

    +

    feature's latest version, as set by the implementation

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/v4.2.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html new file mode 100644 index 0000000000..8347f85bc4 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -0,0 +1,1083 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterModel#

    +

    Hierarchy#

    +
      +
    • ClusterModel
    • +
    +

    Implemented by#

    + +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional accessibleNamespaces#

    +

    accessibleNamespaces? : string[]

    +

    Defined in src/common/cluster-store.ts:68

    +

    List of accessible namespaces

    +
    +

    Optional contextName#

    +

    contextName? : string

    +

    Defined in src/common/cluster-store.ts:54

    +

    User context in kubeconfig

    +
    +

    id#

    +

    id: ClusterId

    +

    Defined in src/common/cluster-store.ts:45

    +

    Unique id for a cluster

    +
    +

    Optional kubeConfig#

    +

    kubeConfig? : string

    +

    Defined in src/common/cluster-store.ts:71

    +

    deprecated

    +
    +

    kubeConfigPath#

    +

    kubeConfigPath: string

    +

    Defined in src/common/cluster-store.ts:48

    +

    Path to cluster kubeconfig

    +
    +

    Optional metadata#

    +

    metadata? : ClusterMetadata

    +

    Defined in src/common/cluster-store.ts:60

    +

    Metadata

    +
    +

    Optional ownerRef#

    +

    ownerRef? : string

    +

    Defined in src/common/cluster-store.ts:65

    +

    If extension sets ownerRef it has to explicitly mark a cluster as enabled during onActive (or when cluster is saved)

    +
    +

    Optional preferences#

    +

    preferences? : ClusterPreferences

    +

    Defined in src/common/cluster-store.ts:57

    +

    Preferences

    +
    +

    Optional workspace#

    +

    workspace? : WorkspaceId

    +

    Defined in src/common/cluster-store.ts:51

    +

    Workspace id

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/v4.2.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html new file mode 100644 index 0000000000..fb1839edef --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WorkspaceModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WorkspaceModel#

    +

    Hierarchy#

    +
      +
    • WorkspaceModel
    • +
    +

    Implemented by#

    + +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional description#

    +

    description? : string

    +

    Defined in src/common/workspace-store.ts:20

    +
    +

    id#

    +

    id: WorkspaceId

    +

    Defined in src/common/workspace-store.ts:18

    +
    +

    Optional lastActiveClusterId#

    +

    lastActiveClusterId? : ClusterId

    +

    Defined in src/common/workspace-store.ts:22

    +
    +

    name#

    +

    name: string

    +

    Defined in src/common/workspace-store.ts:19

    +
    +

    Optional ownerRef#

    +

    ownerRef? : string

    +

    Defined in src/common/workspace-store.ts:21

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html new file mode 100644 index 0000000000..e47ef57c04 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html new file mode 100644 index 0000000000..00fe271444 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html new file mode 100644 index 0000000000..8e708145aa --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html new file mode 100644 index 0000000000..045bb4033d --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterFeatureRegistration#

    +

    Hierarchy#

    +
      +
    • ClusterFeatureRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: ClusterFeatureComponents

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:11

    +
    +

    feature#

    +

    feature: ClusterFeature

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:12

    +
    +

    title#

    +

    title: string

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html new file mode 100644 index 0000000000..cefb2e8781 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -0,0 +1,1019 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterPageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterPageMenuRegistration#

    +

    Hierarchy#

    + +

    ClusterPageMenuRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageMenuComponents

    +

    Inherited from PageMenuRegistration.components

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:16

    +
    +

    Optional parentId#

    +

    parentId? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:17

    +
    +

    Optional target#

    +

    target? : PageTarget

    +

    Inherited from PageMenuRegistration.target

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Inherited from PageMenuRegistration.title

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html new file mode 100644 index 0000000000..635f59bc21 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html new file mode 100644 index 0000000000..5571149dae --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectDetailRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectDetailRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10

    +
    +

    components#

    +

    components: KubeObjectDetailComponents

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9

    +
    +

    Optional priority#

    +

    priority? : number

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html new file mode 100644 index 0000000000..1af7821574 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html new file mode 100644 index 0000000000..24bd2721a7 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectMenuRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectMenuRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10

    +
    +

    components#

    +

    components: KubeObjectMenuComponents

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html new file mode 100644 index 0000000000..c17273d464 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -0,0 +1,1008 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectStatusRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectStatusRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectStatusRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:6

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:5

    +
    +

    resolve#

    +

    resolve: function

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    +

    Type declaration:#

    +

    ▸ (object: KubeObject): KubeObjectStatus

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectKubeObject
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html new file mode 100644 index 0000000000..8210362fe1 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -0,0 +1,977 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponentProps ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html new file mode 100644 index 0000000000..5f46ecbffc --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html new file mode 100644 index 0000000000..d0ecd20a51 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html new file mode 100644 index 0000000000..d35eea2409 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -0,0 +1,992 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageMenuRegistration#

    +

    Hierarchy#

    +
      +
    • PageMenuRegistration
    • +
    +

    ClusterPageMenuRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageMenuComponents

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +
    +

    Optional target#

    +

    target? : PageTarget

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageparams/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageparams/index.html new file mode 100644 index 0000000000..91fc496839 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageparams/index.html @@ -0,0 +1,938 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParams ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageParams ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParams
    • +
    +

    Indexable#

    +
      +
    • [ paramName: string]: V
    • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html new file mode 100644 index 0000000000..0765ab884a --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -0,0 +1,993 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageRegistration#

    +

    Hierarchy#

    +
      +
    • PageRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageComponents

    +

    Defined in src/extensions/registries/page-registry.ts:17

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/extensions/registries/page-registry.ts:15

    +

    Page ID, part of extension's page url, must be unique within same extension +When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension

    +
    +

    Optional params#

    +

    params? : PageParams‹string | ExtensionPageParamInit›

    +

    Defined in src/extensions/registries/page-registry.ts:16

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html new file mode 100644 index 0000000000..f2cf15968d --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageTarget ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html new file mode 100644 index 0000000000..386b80d725 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html @@ -0,0 +1,981 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ProtocolHandlerRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ProtocolHandlerRegistration#

    +

    ProtocolHandlerRegistration is the data required for an extension to register +a handler to a specific path or dynamic path.

    +

    Hierarchy#

    +
      +
    • ProtocolHandlerRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    handler#

    +

    handler: RouteHandler

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:7

    +
    +

    pathSchema#

    +

    pathSchema: string

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:6

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html new file mode 100644 index 0000000000..8f833df7b0 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RegisteredPage - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RegisteredPage#

    +

    Hierarchy#

    +
      +
    • RegisteredPage
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageComponents

    +

    Defined in src/extensions/registries/page-registry.ts:48

    +
    +

    extensionId#

    +

    extensionId: string

    +

    Defined in src/extensions/registries/page-registry.ts:45

    +
    +

    id#

    +

    id: string

    +

    Defined in src/extensions/registries/page-registry.ts:44

    +
    +

    params#

    +

    params: PageParamsPageParam

    +

    Defined in src/extensions/registries/page-registry.ts:47

    +
    +

    url#

    +

    url: string

    +

    Defined in src/extensions/registries/page-registry.ts:46

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.routehandler/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.routehandler/index.html new file mode 100644 index 0000000000..a61aabcb5e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.routehandler/index.html @@ -0,0 +1,948 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RouteHandler - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RouteHandler#

    +

    RouteHandler represents the function signature of the handler function for +lens:// protocol routing.

    +

    Hierarchy#

    +
      +
    • RouteHandler
    • +
    +

    Callable#

    +

    ▸ (params: RouteParams): void

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:42

    +

    RouteHandler represents the function signature of the handler function for +lens:// protocol routing.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsRouteParams
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.routeparams/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.routeparams/index.html new file mode 100644 index 0000000000..65b770eda0 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.routeparams/index.html @@ -0,0 +1,1001 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RouteParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RouteParams#

    +

    The collection of the dynamic parts of a URI which initiated a lens:// +protocol request

    +

    Hierarchy#

    +
      +
    • RouteParams
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    pathname#

    +

    pathname: Record‹string, string›

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:23

    +

    the matching parts of the path. The dynamic parts of the URI path.

    +
    + +

    search: Record‹string, string›

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:18

    +

    the parts of the URI query string

    +
    +

    Optional tail#

    +

    tail? : string

    +

    Defined in src/extensions/registries/protocol-handler-registry.ts:35

    +

    if the most specific path schema that is matched does not cover the whole +of the URI's path. Then this field will be set to the remaining path +segments.

    +

    Example:

    +

    If the path schema /landing/:type is the matched schema for the URI +/landing/soft/easy then this field will be set to "/easy".

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/v4.2.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html new file mode 100644 index 0000000000..33312f81aa --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -0,0 +1,982 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBarRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StatusBarRegistration#

    +

    Hierarchy#

    +
      +
    • StatusBarRegistrationV2
    • +
    +

    StatusBarRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional components#

    +

    components? : StatusBarComponents

    +

    Inherited from StatusBarRegistration.components

    +

    Defined in src/extensions/registries/status-bar-registry.ts:11

    +
    +

    Optional item#

    +

    item? : React.ReactNode

    +

    Defined in src/extensions/registries/status-bar-registry.ts:18

    +

    deprecated use components.Item instead

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html new file mode 100644 index 0000000000..85ad0438d8 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -0,0 +1,4413 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: BadgeProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: BadgeProps#

    +

    Hierarchy#

    + +

    BadgeProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional flat#

    +

    flat? : boolean

    +

    Defined in src/renderer/components/badge/badge.tsx:9

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/badge/badge.tsx:10

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional small#

    +

    small? : boolean

    +

    Defined in src/renderer/components/badge/badge.tsx:8

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Inherited from ButtonProps.tooltipOverrideDisabled

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html new file mode 100644 index 0000000000..cfba5f4287 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -0,0 +1,4664 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ButtonProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ButtonProps#

    +

    Hierarchy#

    + +

    ButtonProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accent#

    +

    accent? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:10

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:15

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from ButtonProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1971

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional big#

    +

    big? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:16

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from ButtonProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1972

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from ButtonProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1973

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from ButtonProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1974

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from ButtonProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1975

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from ButtonProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1976

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from ButtonProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1977

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from ButtonProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1978

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/button/button.tsx:14

    +
    +

    Optional href#

    +

    href? : string

    +

    Defined in src/renderer/components/button/button.tsx:18

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/button/button.tsx:7

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional light#

    +

    light? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:11

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from ButtonProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1979

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional outlined#

    +

    outlined? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:13

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional plain#

    +

    plain? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:12

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional primary#

    +

    primary? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:9

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional round#

    +

    round? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:17

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : "_blank"

    +

    Defined in src/renderer/components/button/button.tsx:19

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Inherited from ButtonProps.tooltipOverrideDisabled

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : "submit" | "reset" | "button"

    +

    Inherited from ButtonProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1980

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from ButtonProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1981

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional waiting#

    +

    waiting? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:8

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html new file mode 100644 index 0000000000..8085f8642f --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -0,0 +1,1091 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CheckboxProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: CheckboxProps ‹T#

    +

    Type parameters#

    +

    T

    +

    Hierarchy#

    +
      +
    • CheckboxProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:7

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:10

    +
    +

    Optional inline#

    +

    inline? : boolean

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:9

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:8

    +
    +

    Optional theme#

    +

    theme? : "dark" | "light"

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:6

    +
    +

    Optional value#

    +

    value? : T

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:11

    +

    Methods#

    +

    Optional onChange#

    +

    onChange(value: T, evt: ChangeEvent‹HTMLInputElement›): void

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:12

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valueT
    evtChangeEvent‹HTMLInputElement›
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html new file mode 100644 index 0000000000..dccb57dc5e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -0,0 +1,1041 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogParams#

    +

    Hierarchy#

    +
      +
    • ConfirmDialogParams
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional cancelButtonProps#

    +

    cancelButtonProps? : Partial‹ButtonProps

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

    +
    +

    Optional icon#

    +

    icon? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

    +
    +

    Optional labelCancel#

    +

    labelCancel? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

    +
    +

    Optional labelOk#

    +

    labelOk? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

    +
    +

    Optional message#

    +

    message? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

    +
    +

    Optional ok#

    +

    ok? : function

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional okButtonProps#

    +

    okButtonProps? : Partial‹ButtonProps

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html new file mode 100644 index 0000000000..915cbe5e14 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -0,0 +1,919 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogProps#

    +

    Hierarchy#

    +
      +
    • object
    • +
    +

    ConfirmDialogProps

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html new file mode 100644 index 0000000000..9f8e2421bd --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CubeSpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html new file mode 100644 index 0000000000..2067aebb59 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -0,0 +1,1071 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DialogProps#

    +

    Hierarchy#

    +
      +
    • DialogProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional animated#

    +

    animated? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:22

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/dialog/dialog.tsx:14

    +
    +

    Optional close#

    +

    close? : function

    +

    Defined in src/renderer/components/dialog/dialog.tsx:17

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional isOpen#

    +

    isOpen? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:15

    +
    +

    Optional modal#

    +

    modal? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:20

    +
    +

    Optional onClose#

    +

    onClose? : function

    +

    Defined in src/renderer/components/dialog/dialog.tsx:19

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional onOpen#

    +

    onOpen? : function

    +

    Defined in src/renderer/components/dialog/dialog.tsx:18

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional open#

    +

    open? : function

    +

    Defined in src/renderer/components/dialog/dialog.tsx:16

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional pinned#

    +

    pinned? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:21

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html new file mode 100644 index 0000000000..1ef2a8f55e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -0,0 +1,4396 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemLabelsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerItemLabelsProps#

    +

    Hierarchy#

    +

    DrawerItemProps

    +

    DrawerItemLabelsProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from DrawerItemProps.className

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from DrawerItemProps.hidden

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    labels#

    +

    labels: string[]

    +

    Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6

    +
    +

    Optional labelsOnly#

    +

    labelsOnly? : boolean

    +

    Inherited from DrawerItemProps.labelsOnly

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:9

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    name#

    +

    name: React.ReactNode

    +

    Inherited from DrawerItemProps.name

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional renderBoolean#

    +

    renderBoolean? : boolean

    +

    Inherited from DrawerItemProps.renderBoolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from DrawerItemProps.title

    +

    Overrides ButtonProps.title

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html new file mode 100644 index 0000000000..b2e5ab62db --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -0,0 +1,4381 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerItemProps#

    +

    Hierarchy#

    +
      +
    • HTMLAttributes‹any›
    • +
    +

    DrawerItemProps

    +

    DrawerItemLabelsProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional labelsOnly#

    +

    labelsOnly? : boolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:9

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    name#

    +

    name: React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional renderBoolean#

    +

    renderBoolean? : boolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Overrides ButtonProps.title

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html new file mode 100644 index 0000000000..3d291ef1e3 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerParamTogglerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html new file mode 100644 index 0000000000..128684211a --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -0,0 +1,1077 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerProps#

    +

    Hierarchy#

    +
      +
    • DrawerProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional animation#

    +

    animation? : AnimateName

    +

    Defined in src/renderer/components/drawer/drawer.tsx:18

    +
    +

    Optional className#

    +

    className? : string | object

    +

    Defined in src/renderer/components/drawer/drawer.tsx:15

    +
    +

    Optional contentClass#

    +

    contentClass? : string | object

    +

    Defined in src/renderer/components/drawer/drawer.tsx:16

    +
    +

    Optional onClose#

    +

    onClose? : function

    +

    Defined in src/renderer/components/drawer/drawer.tsx:19

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    open#

    +

    open: boolean

    +

    Defined in src/renderer/components/drawer/drawer.tsx:11

    +
    +

    Optional position#

    +

    position? : "top" | "left" | "right" | "bottom"

    +

    Defined in src/renderer/components/drawer/drawer.tsx:17

    +
    +

    Optional size#

    +

    size? : string

    +

    Defined in src/renderer/components/drawer/drawer.tsx:13

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer.tsx:12

    +
    +

    Optional toolbar#

    +

    toolbar? : React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer.tsx:20

    +
    +

    Optional usePortal#

    +

    usePortal? : boolean

    +

    Defined in src/renderer/components/drawer/drawer.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html new file mode 100644 index 0000000000..be1247ec01 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerTitleProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html new file mode 100644 index 0000000000..05bc3f7aa5 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: GroupSelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html new file mode 100644 index 0000000000..86fd50d96b --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -0,0 +1,4533 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IconProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IconProps#

    +

    Hierarchy#

    + +

    IconProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:20

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional big#

    +

    big? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:19

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:24

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional focusable#

    +

    focusable? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:22

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional href#

    +

    href? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:15

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional interactive#

    +

    interactive? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:21

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    + +

    link? : LocationDescriptor

    +

    Defined in src/renderer/components/icon/icon.tsx:14

    +
    +

    Optional material#

    +

    material? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:12

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional size#

    +

    size? : string | number

    +

    Defined in src/renderer/components/icon/icon.tsx:16

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional small#

    +

    small? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:17

    +
    +

    Optional smallest#

    +

    smallest? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:18

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional sticker#

    +

    sticker? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:23

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional svg#

    +

    svg? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:13

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Inherited from ButtonProps.tooltipOverrideDisabled

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html new file mode 100644 index 0000000000..cc0f478154 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -0,0 +1,1062 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: InputValidator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: InputValidator#

    +

    Hierarchy#

    +
      +
    • InputValidator
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional debounce#

    +

    debounce? : number

    +

    Defined in src/renderer/components/input/input_validators.ts:6

    +
    +

    Optional message#

    +

    message? : ReactNode | function

    +

    Defined in src/renderer/components/input/input_validators.ts:8

    +

    Methods#

    +

    Optional condition#

    +

    condition(props: InputProps): boolean

    +

    Defined in src/renderer/components/input/input_validators.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsInputProps
    +

    Returns: boolean

    +
    +

    validate#

    +

    validate(value: string, props?: InputProps): boolean | Promise‹any›

    +

    Defined in src/renderer/components/input/input_validators.ts:9

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valuestring
    props?InputProps
    +

    Returns: boolean | Promise‹any›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html new file mode 100644 index 0000000000..ea2375114d --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeEventDetailsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html new file mode 100644 index 0000000000..130f38c875 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailsProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html new file mode 100644 index 0000000000..1dfbd4a172 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -0,0 +1,1513 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectListLayoutProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Interface: KubeObjectListLayoutProps ‹T#

    +

    Type parameters#

    +

    T: ItemObject

    +

    Hierarchy#

    +
      +
    • ItemListLayoutProps
    • +
    +

    KubeObjectListLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional addRemoveButtons#

    +

    addRemoveButtons? : Partial‹AddRemoveButtonsProps›

    +

    Inherited from KubeObjectListLayoutProps.addRemoveButtons

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

    +
    +

    className#

    +

    className: IClassName

    +

    Inherited from KubeObjectListLayoutProps.className

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

    +
    +

    Optional copyClassNameFromHeadCells#

    +

    copyClassNameFromHeadCells? : boolean

    +

    Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62

    +
    +

    Optional customizeHeader#

    +

    customizeHeader? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

    +

    Type declaration:#

    +

    ▸ (placeholders: IHeaderPlaceholders, content: ReactNode): Partial‹IHeaderPlaceholders› | ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    placeholdersIHeaderPlaceholders
    contentReactNode
    +
    +

    Optional customizeRemoveDialog#

    +

    customizeRemoveDialog? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

    +

    Type declaration:#

    +

    ▸ (selectedItems: T[]): Partial‹ConfirmDialogParams

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    selectedItemsT[]
    +
    +

    Optional customizeTableRowProps#

    +

    customizeTableRowProps? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeTableRowProps

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:68

    +

    Type declaration:#

    +

    ▸ (item: T): Partial‹TableRowProps

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional dependentStores#

    +

    dependentStores? : KubeObjectStore[]

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15

    +
    +

    Optional detailsItem#

    +

    detailsItem? : T

    +

    Inherited from KubeObjectListLayoutProps.detailsItem

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74

    +
    +

    Optional filterItems#

    +

    filterItems? : ItemsFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.filterItems

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

    +

    deprecated

    +
    +

    Optional hasDetailsView#

    +

    hasDetailsView? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hasDetailsView

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73

    +
    +

    Optional headerClassName#

    +

    headerClassName? : IClassName

    +

    Inherited from KubeObjectListLayoutProps.headerClassName

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

    +
    +

    Optional hideFilters#

    +

    hideFilters? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hideFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

    +
    +

    Optional isClusterScoped#

    +

    isClusterScoped? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isClusterScoped

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

    +
    +

    Optional isConfigurable#

    +

    isConfigurable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isConfigurable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61

    +
    +

    Optional isReady#

    +

    isReady? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isReady

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

    +
    +

    Optional isSearchable#

    +

    isSearchable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSearchable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

    +
    +

    Optional isSelectable#

    +

    isSelectable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSelectable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

    +
    +

    Optional items#

    +

    items? : T[]

    +

    Inherited from KubeObjectListLayoutProps.items

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

    +
    +

    Optional onDetails#

    +

    onDetails? : function

    +

    Inherited from KubeObjectListLayoutProps.onDetails

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

    +

    Type declaration:#

    +

    ▸ (item: T): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional preloadStores#

    +

    preloadStores? : boolean

    +

    Inherited from KubeObjectListLayoutProps.preloadStores

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44

    +
    +

    Optional renderFooter#

    +

    renderFooter? : function

    +

    Inherited from KubeObjectListLayoutProps.renderFooter

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:79

    +

    Type declaration:#

    +

    ▸ (parent: ItemListLayout): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    parentItemListLayout
    +
    +

    Optional renderHeaderTitle#

    +

    renderHeaderTitle? : ReactNode | function

    +

    Inherited from KubeObjectListLayoutProps.renderHeaderTitle

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

    +
    +

    Optional renderItemMenu#

    +

    renderItemMenu? : function

    +

    Inherited from KubeObjectListLayoutProps.renderItemMenu

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

    +

    Type declaration:#

    +

    ▸ (item: T, store: ItemStore‹T›): ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    storeItemStore‹T›
    +
    +

    renderTableContents#

    +

    renderTableContents: function

    +

    Inherited from KubeObjectListLayoutProps.renderTableContents

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

    +

    Type declaration:#

    +

    ▸ (item: T): (string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹› | TableCellProps‹›)[]

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    renderTableHeader#

    +

    renderTableHeader: TableCellProps[] | null

    +

    Inherited from KubeObjectListLayoutProps.renderTableHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65

    +
    +

    Optional searchFilters#

    +

    searchFilters? : SearchFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.searchFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

    +
    +

    Optional showHeader#

    +

    showHeader? : boolean

    +

    Inherited from KubeObjectListLayoutProps.showHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

    +
    +

    Optional sortingCallbacks#

    +

    sortingCallbacks? : object

    +

    Inherited from KubeObjectListLayoutProps.sortingCallbacks

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

    +

    Type declaration:#

    + +
    +

    store#

    +

    store: KubeObjectStore

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:14

    +
    +

    Optional tableId#

    +

    tableId? : string

    +

    Inherited from KubeObjectListLayoutProps.tableId

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:39

    +
    +

    Optional tableProps#

    +

    tableProps? : Partial‹TableProps

    +

    Inherited from KubeObjectListLayoutProps.tableProps

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:64

    +
    +

    Optional virtual#

    +

    virtual? : boolean

    +

    Inherited from KubeObjectListLayoutProps.virtual

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:70

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html new file mode 100644 index 0000000000..bddfe8a5f5 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectMenuProps ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +

    MenuActionsProps

    +

    KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoCloseOnSelect#

    +

    autoCloseOnSelect? : boolean

    +

    Inherited from MenuActionsProps.autoCloseOnSelect

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from MenuActionsProps.className

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:14

    +
    +

    Optional editable#

    +

    editable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:12

    +
    +

    object#

    +

    object: T

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:11

    +
    +

    Optional removable#

    +

    removable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:13

    +
    +

    Optional removeConfirmationMessage#

    +

    removeConfirmationMessage? : React.ReactNode | function

    +

    Inherited from MenuActionsProps.removeConfirmationMessage

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +
    +

    Optional toolbar#

    +

    toolbar? : boolean

    +

    Inherited from MenuActionsProps.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:15

    +
    +

    Optional triggerIcon#

    +

    triggerIcon? : string | IconProps | React.ReactNode

    +

    Inherited from MenuActionsProps.triggerIcon

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +

    Methods#

    +

    Optional removeAction#

    +

    removeAction(): void

    +

    Inherited from MenuActionsProps.removeAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    updateAction(): void

    +

    Inherited from MenuActionsProps.updateAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html new file mode 100644 index 0000000000..c64b681369 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMetaProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html new file mode 100644 index 0000000000..c0d9ed96e6 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html @@ -0,0 +1,5781 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: LineProgressProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: LineProgressProps#

    +

    Hierarchy#

    + +

    LineProgressProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : any

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:10

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number

    +

    Overrides MenuItemProps.max

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:9

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number

    +

    Overrides MenuItemProps.min

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:8

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional precise#

    +

    precise? : number

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:11

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Inherited from ButtonProps.tooltipOverrideDisabled

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    value#

    +

    value: number

    +

    Overrides MenuItemProps.value

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:7

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html new file mode 100644 index 0000000000..ab2dccae06 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html @@ -0,0 +1,1066 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuActionsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuActionsProps#

    +

    Hierarchy#

    +
      +
    • object
    • +
    +

    MenuActionsProps

    +

    KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoCloseOnSelect#

    +

    autoCloseOnSelect? : boolean

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:14

    +
    +

    Optional removeConfirmationMessage#

    +

    removeConfirmationMessage? : React.ReactNode | function

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +
    +

    Optional toolbar#

    +

    toolbar? : boolean

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:15

    +
    +

    Optional triggerIcon#

    +

    triggerIcon? : string | IconProps | React.ReactNode

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +

    Methods#

    +

    Optional removeAction#

    +

    removeAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    updateAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html new file mode 100644 index 0000000000..464c1f544e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html @@ -0,0 +1,5772 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuItemProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
    • +
    +

    MenuItemProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:307

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Overrides LineProgressProps.disabled

    +

    Defined in src/renderer/components/menu/menu.tsx:306

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Overrides LineProgressProps.href

    +

    Defined in src/renderer/components/menu/menu.tsx:309

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional icon#

    +

    icon? : string | Partial‹IconProps

    +

    Defined in src/renderer/components/menu/menu.tsx:305

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spacer#

    +

    spacer? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:308

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html new file mode 100644 index 0000000000..e56e1ece3a --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuPosition#

    +

    Hierarchy#

    +
      +
    • MenuPosition
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional bottom#

    +

    bottom? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:17

    +
    +

    Optional left#

    +

    left? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:14

    +
    +

    Optional right#

    +

    right? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:16

    +
    +

    Optional top#

    +

    top? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:15

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html new file mode 100644 index 0000000000..28b6a61f9f --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html @@ -0,0 +1,1148 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuProps#

    +

    Hierarchy#

    +
      +
    • MenuProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:27

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Defined in src/renderer/components/menu/menu.tsx:33

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:25

    +
    +

    Optional closeOnClickItem#

    +

    closeOnClickItem? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:29

    +
    +

    Optional closeOnClickOutside#

    +

    closeOnClickOutside? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:30

    +
    +

    Optional closeOnScroll#

    +

    closeOnScroll? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:31

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:26

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:24

    +
    +

    Optional isOpen#

    +

    isOpen? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:21

    +
    +

    Optional position#

    +

    position? : MenuPosition

    +

    Defined in src/renderer/components/menu/menu.tsx:32

    +
    +

    Optional toggleEvent#

    +

    toggleEvent? : "click" | "contextmenu"

    +

    Defined in src/renderer/components/menu/menu.tsx:34

    +
    +

    Optional usePortal#

    +

    usePortal? : boolean | HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:28

    +

    Methods#

    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:23

    +

    Returns: void

    +
    +

    open#

    +

    open(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:22

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html new file mode 100644 index 0000000000..9eeae0979e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html @@ -0,0 +1,1039 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: Notification - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: Notification#

    +

    Hierarchy#

    +
      +
    • Notification
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional id#

    +

    id? : NotificationId

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:17

    +
    +

    message#

    +

    message: NotificationMessage

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:18

    +
    +

    Optional status#

    +

    status? : NotificationStatus

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:19

    +
    +

    Optional timeout#

    +

    timeout? : number

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:20

    +

    Methods#

    +

    Optional onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:21

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html new file mode 100644 index 0000000000..fb11d75349 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -0,0 +1,3191 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageLayoutProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹any›
    • +
    +

    PageLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional back#

    +

    back? : function

    +

    Defined in src/renderer/components/layout/page-layout.tsx:19

    +

    Type declaration:#

    +

    ▸ (evt: MouseEvent | KeyboardEvent): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent | KeyboardEvent
    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:11

    +
    +

    Optional contentClass#

    +

    contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:14

    +
    +

    Optional contentGaps#

    +

    contentGaps? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:16

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    + +

    header: React.ReactNode

    +

    Defined in src/renderer/components/layout/page-layout.tsx:12

    +
    +

    Optional headerClass#

    +

    headerClass? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:13

    +
    +

    Optional navigation#

    +

    navigation? : NavigationTree[]

    +

    Defined in src/renderer/components/layout/page-layout.tsx:18

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional provideBackButtonNavigation#

    +

    provideBackButtonNavigation? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:15

    +
    +

    Optional showOnTop#

    +

    showOnTop? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:17

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html new file mode 100644 index 0000000000..eddb192fd5 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -0,0 +1,1054 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RadioGroupProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RadioGroupProps#

    +

    Hierarchy#

    +
      +
    • RadioGroupProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional asButtons#

    +

    asButtons? : boolean

    +

    Defined in src/renderer/components/radio/radio.tsx:11

    +
    +

    Optional className#

    +

    className? : any

    +

    Defined in src/renderer/components/radio/radio.tsx:9

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/radio/radio.tsx:12

    +
    +

    Optional value#

    +

    value? : any

    +

    Defined in src/renderer/components/radio/radio.tsx:10

    +

    Methods#

    +

    Optional onChange#

    +

    onChange(value: string): void

    +

    Defined in src/renderer/components/radio/radio.tsx:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html new file mode 100644 index 0000000000..19f8e061b8 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html new file mode 100644 index 0000000000..fa3da4deee --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -0,0 +1,2253 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SelectProps ‹T#

    +

    Type parameters#

    +

    T

    +

    Hierarchy#

    +
      +
    • +

      Props‹T›

      +
    • +
    • +

      CreatableProps‹T›

      +
    • +
    +

    SelectProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional allowCreateWhileLoading#

    +

    allowCreateWhileLoading? : boolean

    +

    Inherited from SelectProps.allowCreateWhileLoading

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:11

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from SelectProps.aria-label

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:58

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from SelectProps.aria-labelledby

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:60

    +
    +

    Optional autoConvertOptions#

    +

    autoConvertOptions? : boolean

    +

    Defined in src/renderer/components/select/select.tsx:30

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from SelectProps.autoFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:62

    +
    +

    Optional backspaceRemovesValue#

    +

    backspaceRemovesValue? : boolean

    +

    Inherited from SelectProps.backspaceRemovesValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:64

    +
    +

    Optional blurInputOnSelect#

    +

    blurInputOnSelect? : boolean

    +

    Inherited from SelectProps.blurInputOnSelect

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:66

    +
    +

    Optional captureMenuScroll#

    +

    captureMenuScroll? : boolean

    +

    Inherited from SelectProps.captureMenuScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:68

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from SelectProps.className

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:70

    +
    +

    Optional classNamePrefix#

    +

    classNamePrefix? : string | null

    +

    Inherited from SelectProps.classNamePrefix

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:72

    +
    +

    Optional closeMenuOnScroll#

    +

    closeMenuOnScroll? : boolean | EventListener

    +

    Inherited from SelectProps.closeMenuOnScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:87

    +
    +

    Optional closeMenuOnSelect#

    +

    closeMenuOnSelect? : boolean

    +

    Inherited from SelectProps.closeMenuOnSelect

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:74

    +
    +

    Optional components#

    +

    components? : SelectComponentsConfig‹T›

    +

    Inherited from SelectProps.components

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:97

    +
    +

    Optional controlShouldRenderValue#

    +

    controlShouldRenderValue? : boolean

    +

    Inherited from SelectProps.controlShouldRenderValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:99

    +
    +

    Optional createOptionPosition#

    +

    createOptionPosition? : "first" | "last"

    +

    Inherited from SelectProps.createOptionPosition

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:26

    +
    +

    Optional defaultInputValue#

    +

    defaultInputValue? : string

    +

    Inherited from SelectProps.defaultInputValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:207

    +
    +

    Optional defaultMenuIsOpen#

    +

    defaultMenuIsOpen? : boolean

    +

    Inherited from SelectProps.defaultMenuIsOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:208

    +
    +

    Optional defaultValue#

    +

    defaultValue? : ValueType‹T›

    +

    Inherited from SelectProps.defaultValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:209

    +
    +

    Optional delimiter#

    +

    delimiter? : string

    +

    Inherited from SelectProps.delimiter

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:101

    +
    +

    Optional escapeClearsValue#

    +

    escapeClearsValue? : boolean

    +

    Inherited from SelectProps.escapeClearsValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:103

    +
    +

    Optional filterOption#

    +

    filterOption? : function | null

    +

    Inherited from SelectProps.filterOption

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:105

    +
    +

    Optional formatCreateLabel#

    +

    formatCreateLabel? : function

    +

    Inherited from SelectProps.formatCreateLabel

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:14

    +

    Type declaration:#

    +

    ▸ (inputValue: string): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional formatGroupLabel#

    +

    formatGroupLabel? : formatGroupLabel‹T›

    +

    Inherited from SelectProps.formatGroupLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:110

    +
    +

    Optional formatOptionLabel#

    +

    formatOptionLabel? : function

    +

    Inherited from SelectProps.formatOptionLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:112

    +

    Type declaration:#

    +

    ▸ (option: T, labelMeta: FormatOptionLabelMeta‹T›): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    labelMetaFormatOptionLabelMeta‹T›
    +
    +

    Optional getNewOptionData#

    +

    getNewOptionData? : function

    +

    Inherited from SelectProps.getNewOptionData

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:20

    +

    Type declaration:#

    +

    ▸ (inputValue: string, optionLabel: React.ReactNode): T

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    inputValuestring
    optionLabelReact.ReactNode
    +
    +

    Optional getOptionLabel#

    +

    getOptionLabel? : getOptionLabel‹T›

    +

    Inherited from SelectProps.getOptionLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:114

    +
    +

    Optional getOptionValue#

    +

    getOptionValue? : getOptionValue‹T›

    +

    Inherited from SelectProps.getOptionValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:116

    +
    +

    Optional hideSelectedOptions#

    +

    hideSelectedOptions? : boolean

    +

    Inherited from SelectProps.hideSelectedOptions

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:118

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from SelectProps.id

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:120

    +
    +

    Optional inputId#

    +

    inputId? : string

    +

    Inherited from SelectProps.inputId

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:124

    +
    +

    Optional inputValue#

    +

    inputValue? : string

    +

    Inherited from SelectProps.inputValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:122

    +
    +

    Optional instanceId#

    +

    instanceId? : number | string

    +

    Inherited from SelectProps.instanceId

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:126

    +
    +

    Optional isClearable#

    +

    isClearable? : boolean

    +

    Inherited from SelectProps.isClearable

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:128

    +
    +

    Optional isCreatable#

    +

    isCreatable? : boolean

    +

    Defined in src/renderer/components/select/select.tsx:29

    +
    +

    Optional isDisabled#

    +

    isDisabled? : boolean

    +

    Inherited from SelectProps.isDisabled

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:130

    +
    +

    Optional isLoading#

    +

    isLoading? : boolean

    +

    Inherited from SelectProps.isLoading

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:132

    +
    +

    Optional isMulti#

    +

    isMulti? : boolean

    +

    Inherited from SelectProps.isMulti

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:138

    +
    +

    Optional isOptionDisabled#

    +

    isOptionDisabled? : function

    +

    Inherited from SelectProps.isOptionDisabled

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:134

    +

    Type declaration:#

    +

    ▸ (option: T, options: OptionsType‹T›): boolean | false

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    optionsOptionsType‹T›
    +
    +

    Optional isOptionSelected#

    +

    isOptionSelected? : function

    +

    Inherited from SelectProps.isOptionSelected

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:136

    +

    Type declaration:#

    +

    ▸ (option: T, options: OptionsType‹T›): boolean

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    optionsOptionsType‹T›
    +
    +

    Optional isRtl#

    +

    isRtl? : boolean

    +

    Inherited from SelectProps.isRtl

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:140

    +
    +

    Optional isSearchable#

    +

    isSearchable? : boolean

    +

    Inherited from SelectProps.isSearchable

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:142

    +
    +

    Optional isValidNewOption#

    +

    isValidNewOption? : function

    +

    Inherited from SelectProps.isValidNewOption

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:17

    +

    Type declaration:#

    +

    ▸ (inputValue: string, value: ValueType‹T›, options: OptionsType‹T›): boolean

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    inputValuestring
    valueValueType‹T›
    optionsOptionsType‹T›
    +
    +

    Optional loadingMessage#

    +

    loadingMessage? : function

    +

    Inherited from SelectProps.loadingMessage

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:144

    +

    Type declaration:#

    +

    ▸ (obj: object): string | null

    +

    Parameters:

    +

    obj: object

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional maxMenuHeight#

    +

    maxMenuHeight? : number

    +

    Inherited from SelectProps.maxMenuHeight

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:148

    +
    +

    Optional menuClass#

    +

    menuClass? : string

    +

    Defined in src/renderer/components/select/select.tsx:28

    +
    +

    Optional menuIsOpen#

    +

    menuIsOpen? : boolean

    +

    Inherited from SelectProps.menuIsOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:150

    +
    +

    Optional menuPlacement#

    +

    menuPlacement? : MenuPlacement

    +

    Inherited from SelectProps.menuPlacement

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:153

    +
    +

    Optional menuPortalTarget#

    +

    menuPortalTarget? : HTMLElement | null

    +

    Inherited from SelectProps.menuPortalTarget

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:157

    +
    +

    Optional menuPosition#

    +

    menuPosition? : MenuPosition

    +

    Inherited from SelectProps.menuPosition

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:155

    +
    +

    Optional menuShouldBlockScroll#

    +

    menuShouldBlockScroll? : boolean

    +

    Inherited from SelectProps.menuShouldBlockScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:159

    +
    +

    Optional menuShouldScrollIntoView#

    +

    menuShouldScrollIntoView? : boolean

    +

    Inherited from SelectProps.menuShouldScrollIntoView

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:161

    +
    +

    Optional minMenuHeight#

    +

    minMenuHeight? : number

    +

    Inherited from SelectProps.minMenuHeight

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:146

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from SelectProps.name

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:163

    +
    +

    Optional noOptionsMessage#

    +

    noOptionsMessage? : function

    +

    Inherited from SelectProps.noOptionsMessage

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:165

    +

    Type declaration:#

    +

    ▸ (obj: object): string | null

    +

    Parameters:

    +

    obj: object

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler

    +

    Inherited from SelectProps.onBlur

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:167

    +
    +

    Optional onCreateOption#

    +

    onCreateOption? : function

    +

    Inherited from SelectProps.onCreateOption

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:24

    +

    Type declaration:#

    +

    ▸ (inputValue: string): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler

    +

    Inherited from SelectProps.onFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:171

    +
    +

    Optional onInputChange#

    +

    onInputChange? : function

    +

    Inherited from SelectProps.onInputChange

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:173

    +

    Type declaration:#

    +

    ▸ (newValue: string, actionMeta: InputActionMeta): void

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    newValuestring
    actionMetaInputActionMeta
    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler

    +

    Inherited from SelectProps.onKeyDown

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:175

    +
    +

    Optional onMenuClose#

    +

    onMenuClose? : function

    +

    Inherited from SelectProps.onMenuClose

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:179

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional onMenuOpen#

    +

    onMenuOpen? : function

    +

    Inherited from SelectProps.onMenuOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:177

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional onMenuScrollToBottom#

    +

    onMenuScrollToBottom? : function

    +

    Inherited from SelectProps.onMenuScrollToBottom

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:183

    +

    Type declaration:#

    +

    ▸ (event: SyntheticEvent‹HTMLElement›): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventSyntheticEvent‹HTMLElement›
    +
    +

    Optional onMenuScrollToTop#

    +

    onMenuScrollToTop? : function

    +

    Inherited from SelectProps.onMenuScrollToTop

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:181

    +

    Type declaration:#

    +

    ▸ (event: SyntheticEvent‹HTMLElement›): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventSyntheticEvent‹HTMLElement›
    +
    +

    Optional openMenuOnClick#

    +

    openMenuOnClick? : boolean

    +

    Inherited from SelectProps.openMenuOnClick

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:187

    +
    +

    Optional openMenuOnFocus#

    +

    openMenuOnFocus? : boolean

    +

    Inherited from SelectProps.openMenuOnFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:185

    +
    +

    Optional options#

    +

    options? : GroupedOptionsType‹T› | OptionsType‹T›

    +

    Inherited from SelectProps.options

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:189

    +
    +

    Optional pageSize#

    +

    pageSize? : number

    +

    Inherited from SelectProps.pageSize

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:191

    +
    +

    Optional placeholder#

    +

    placeholder? : React.ReactNode

    +

    Inherited from SelectProps.placeholder

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:193

    +
    +

    Optional screenReaderStatus#

    +

    screenReaderStatus? : function

    +

    Inherited from SelectProps.screenReaderStatus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:195

    +

    Type declaration:#

    +

    ▸ (obj: object): string

    +

    Parameters:

    +

    obj: object

    + + + + + + + + + + + + + +
    NameType
    countnumber
    +
    +

    Optional styles#

    +

    styles? : StylesConfig

    +

    Inherited from SelectProps.styles

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:197

    +
    +

    Optional tabIndex#

    +

    tabIndex? : string | null

    +

    Inherited from SelectProps.tabIndex

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:201

    +
    +

    Optional tabSelectsValue#

    +

    tabSelectsValue? : boolean

    +

    Inherited from SelectProps.tabSelectsValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:203

    +
    +

    Optional theme#

    +

    theme? : ThemeConfig

    +

    Inherited from SelectProps.theme

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:199

    +
    +

    Optional themeName#

    +

    themeName? : "dark" | "light" | "outlined"

    +

    Defined in src/renderer/components/select/select.tsx:27

    +
    +

    Optional value#

    +

    value? : T

    +

    Overrides void

    +

    Defined in src/renderer/components/select/select.tsx:26

    +

    Methods#

    +

    Optional onChange#

    +

    onChange(option: T, meta?: ActionMeta‹any›): void

    +

    Overrides void

    +

    Defined in src/renderer/components/select/select.tsx:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    meta?ActionMeta‹any›
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html new file mode 100644 index 0000000000..bd3419fe3e --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SliderProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SliderProps#

    +

    Hierarchy#

    +
      +
    • object
    • +
    +

    SliderProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/slider/slider.tsx:10

    +

    Methods#

    +

    Optional onChange#

    +

    onChange(evt: FormEvent‹any›, value: number): void

    +

    Defined in src/renderer/components/slider/slider.tsx:11

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    evtFormEvent‹any›
    valuenumber
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html new file mode 100644 index 0000000000..55a846c9b6 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -0,0 +1,5772 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SpinnerProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
    • +
    +

    SpinnerProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional center#

    +

    center? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:8

    +
    +

    Optional centerHorizontal#

    +

    centerHorizontal? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:9

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional singleColor#

    +

    singleColor? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:7

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html new file mode 100644 index 0000000000..8a9802e493 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -0,0 +1,4377 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBrickProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StatusBrickProps#

    +

    Hierarchy#

    + +

    StatusBrickProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Inherited from ButtonProps.tooltipOverrideDisabled

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html new file mode 100644 index 0000000000..59f609f8a5 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -0,0 +1,5748 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StepperProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StepperProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
    • +
    +

    StepperProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    step#

    +

    step: number

    +

    Overrides LineProgressProps.step

    +

    Defined in src/renderer/components/stepper/stepper.tsx:6

    +
    +

    steps#

    +

    steps: Step[]

    +

    Defined in src/renderer/components/stepper/stepper.tsx:7

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html new file mode 100644 index 0000000000..021e6518b1 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabLayoutProps#

    +

    Hierarchy#

    +
      +
    • TabLayoutProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    children? : ReactNode

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:15

    +
    +

    Optional className#

    +

    className? : IClassName

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:12

    +
    +

    Optional contentClass#

    +

    contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:13

    +
    +

    Optional tabs#

    +

    tabs? : TabLayoutRoute[]

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html new file mode 100644 index 0000000000..4100f223fd --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -0,0 +1,1027 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutRoute - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabLayoutRoute#

    +

    Hierarchy#

    +
      +
    • TabLayoutRoute
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    component#

    +

    component: React.ComponentType‹any›

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:21

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:24

    +
    +

    Optional exact#

    +

    exact? : boolean

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:23

    +
    +

    routePath#

    +

    routePath: string

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:19

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:20

    +
    +

    Optional url#

    +

    url? : string

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:22

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html new file mode 100644 index 0000000000..1a450fae1f --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -0,0 +1,3237 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableCellProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableCellProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableCellProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional _nowrap#

    +

    _nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:22

    +
    +

    Optional _sorting#

    +

    _sorting? : Partial‹TableSortParams

    +

    Defined in src/renderer/components/table/table-cell.tsx:20

    +
    +

    Optional checkbox#

    +

    checkbox? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:15

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:13

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:12

    +
    +

    Optional isChecked#

    +

    isChecked? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:16

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional renderBoolean#

    +

    renderBoolean? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:17

    +
    +

    Optional showWithColumn#

    +

    showWithColumn? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:19

    +
    +

    Optional sortBy#

    +

    sortBy? : TableSortBy

    +

    Defined in src/renderer/components/table/table-cell.tsx:18

    +
    +

    Optional title#

    +

    title? : ReactNode

    +

    Defined in src/renderer/components/table/table-cell.tsx:14

    +

    Methods#

    +

    Optional _sort#

    +

    _sort(sortBy: TableSortBy): void

    +

    Defined in src/renderer/components/table/table-cell.tsx:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    sortByTableSortBy
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html new file mode 100644 index 0000000000..6d2e980d44 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -0,0 +1,3114 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableHeadProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableHeadProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableHeadProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table-head.tsx:9

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional nowrap#

    +

    nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:12

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional showTopLine#

    +

    showTopLine? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:10

    +
    +

    Optional sticky#

    +

    sticky? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html new file mode 100644 index 0000000000..ad9a5130cd --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -0,0 +1,3343 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional autoSize#

    +

    autoSize? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:26

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table.tsx:25

    +
    +

    Optional customRowHeights#

    +

    customRowHeights? : function

    +

    Defined in src/renderer/components/table/table.tsx:43

    +

    Type declaration:#

    +

    ▸ (item: object, lineHeight: number, paddings: number): number

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    itemobject
    lineHeightnumber
    paddingsnumber
    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional getTableRow#

    +

    getTableRow? : function

    +

    Defined in src/renderer/components/table/table.tsx:44

    +

    Type declaration:#

    +

    ▸ (uid: string): ReactElement‹TableRowProps

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +
    +

    Optional items#

    +

    items? : ItemObject[]

    +

    Defined in src/renderer/components/table/table.tsx:24

    +
    +

    Optional noItems#

    +

    noItems? : React.ReactNode

    +

    Defined in src/renderer/components/table/table.tsx:38

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onSort#

    +

    onSort? : function

    +

    Defined in src/renderer/components/table/table.tsx:37

    +

    Type declaration:#

    +

    ▸ (params: TableSortParams): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsTableSortParams
    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional rowLineHeight#

    +

    rowLineHeight? : string

    +

    Defined in src/renderer/components/table/table.tsx:42

    +
    +

    Optional rowPadding#

    +

    rowPadding? : string

    +

    Defined in src/renderer/components/table/table.tsx:41

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:28

    +
    +

    Optional selectable#

    +

    selectable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:27

    +
    +

    Optional selectedItemId#

    +

    selectedItemId? : string

    +

    Defined in src/renderer/components/table/table.tsx:39

    +
    +

    Optional sortByDefault#

    +

    sortByDefault? : Partial‹TableSortParams

    +

    Defined in src/renderer/components/table/table.tsx:36

    +
    +

    Optional sortSyncWithUrl#

    +

    sortSyncWithUrl? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:35

    +
    +

    Optional sortable#

    +

    sortable? : TableSortCallbacks

    +

    Defined in src/renderer/components/table/table.tsx:34

    +

    Define sortable callbacks for every column in

    +

    sortitem argument in the callback is an object, provided in

    +
    +

    Optional storageKey#

    +

    storageKey? : string

    +

    Defined in src/renderer/components/table/table.tsx:29

    +
    +

    Optional tableId#

    +

    tableId? : string

    +

    Defined in src/renderer/components/table/table.tsx:23

    +
    +

    Optional virtual#

    +

    virtual? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:40

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html new file mode 100644 index 0000000000..e82d7dc3b3 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableRowProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableRowProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableRowProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table-row.tsx:10

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/table/table-row.tsx:16

    +
    +

    Optional nowrap#

    +

    nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-row.tsx:13

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional searchItem#

    +

    searchItem? : ItemObject | any

    +

    Defined in src/renderer/components/table/table-row.tsx:15

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Defined in src/renderer/components/table/table-row.tsx:11

    +
    +

    Optional sortItem#

    +

    sortItem? : ItemObject | any

    +

    Defined in src/renderer/components/table/table-row.tsx:14

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Defined in src/renderer/components/table/table-row.tsx:12

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html new file mode 100644 index 0000000000..8ae232eff2 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -0,0 +1,3159 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLElement›
    • +
    +

    TabProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:56

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:55

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:57

    +
    +

    Optional icon#

    +

    icon? : React.ReactNode | string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:58

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:54

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/tabs/tabs.tsx:59

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    value#

    +

    value: D

    +

    Defined in src/renderer/components/tabs/tabs.tsx:60

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html new file mode 100644 index 0000000000..fa969b28eb --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -0,0 +1,1109 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabsProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabsProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • +

      TabsContextValue‹D›

      +
    • +
    • +

      object

      +
    • +
    +

    TabsProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from TabsProps.autoFocus

    +

    Defined in src/renderer/components/tabs/tabs.tsx:9

    +
    +

    Optional center#

    +

    center? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:19

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:18

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:21

    +
    +

    Optional value#

    +

    value? : D

    +

    Inherited from TabsProps.value

    +

    Defined in src/renderer/components/tabs/tabs.tsx:11

    +
    +

    Optional withBorder#

    +

    withBorder? : boolean

    +

    Inherited from TabsProps.withBorder

    +

    Defined in src/renderer/components/tabs/tabs.tsx:10

    +
    +

    Optional wrap#

    +

    wrap? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:20

    +

    Methods#

    +

    Optional onChange#

    +

    onChange(value: D): void

    +

    Inherited from TabsProps.onChange

    +

    Defined in src/renderer/components/tabs/tabs.tsx:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueD
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html new file mode 100644 index 0000000000..b8c5b8b1d9 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipContentFormatters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipContentFormatters#

    +

    Hierarchy#

    +
      +
    • TooltipContentFormatters
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional narrow#

    +

    narrow? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:34

    +
    +

    Optional nowrap#

    +

    nowrap? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:37

    +
    +

    Optional small#

    +

    small? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:36

    +
    +

    Optional tableView#

    +

    tableView? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:38

    +
    +

    Optional warning#

    +

    warning? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:35

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html new file mode 100644 index 0000000000..103d2499bf --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -0,0 +1,986 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipDecoratorProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipDecoratorProps#

    +

    Hierarchy#

    +
      +
    • TooltipDecoratorProps
    • +
    +

    ButtonProps

    +

    IconProps

    +

    BadgeProps

    +

    LineProgressProps

    +

    StatusBrickProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional tooltip#

    +

    tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    tooltipOverrideDisabled? : boolean

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:15

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html new file mode 100644 index 0000000000..d684f70974 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -0,0 +1,1075 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipProps#

    +

    Hierarchy#

    +
      +
    • TooltipProps
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    children? : React.ReactNode

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:30

    +
    +

    Optional className#

    +

    className? : IClassName

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:27

    +
    +

    Optional formatters#

    +

    formatters? : TooltipContentFormatters

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:28

    +
    +

    Optional offset#

    +

    offset? : number

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:24

    +
    +

    Optional preferredPositions#

    +

    preferredPositions? : TooltipPosition | TooltipPosition[]

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:26

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:29

    +
    +

    targetId#

    +

    targetId: string

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:21

    +
    +

    Optional tooltipOnParentHover#

    +

    tooltipOnParentHover? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:22

    +
    +

    Optional usePortal#

    +

    usePortal? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:25

    +
    +

    Optional visible#

    +

    visible? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:23

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html new file mode 100644 index 0000000000..54a4cef248 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WizardLayoutProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹any›
    • +
    +

    WizardLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional centered#

    +

    centered? : boolean

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:13

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:7

    +
    +

    Optional contentClass#

    +

    contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:10

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:#

    +
      +
    • __html: string
    • +
    +
    +

    Optional header#

    +

    header? : React.ReactNode

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:8

    +
    +

    Optional headerClass#

    +

    headerClass? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:9

    +
    +

    Optional infoPanel#

    +

    infoPanel? : React.ReactNode

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:12

    +
    +

    Optional infoPanelClass#

    +

    infoPanelClass? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:11

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html new file mode 100644 index 0000000000..2e5ac2dc8b --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -0,0 +1,1117 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WizardProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • WizardCommonProps
    • +
    +

    WizardProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:18

    +
    +

    Optional data#

    +

    data? : Partial‹D›

    +

    Inherited from WizardProps.data

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +
    +

    Optional done#

    +

    done? : function

    +

    Inherited from WizardProps.done

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional header#

    +

    header? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:21

    +
    +

    Optional hideSteps#

    +

    hideSteps? : boolean

    +

    Inherited from WizardProps.hideSteps

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +
    +

    Optional onChange#

    +

    onChange? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:22

    +

    Type declaration:#

    +

    ▸ (step: number): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +
    +

    Optional reset#

    +

    reset? : function

    +

    Inherited from WizardProps.reset

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional save#

    +

    save? : function

    +

    Inherited from WizardProps.save

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Type declaration:#

    +

    ▸ (data: Partial‹D›, callback?: function): void

    +

    Parameters:

    +

    data: Partial‹D›

    +

    Optional callback: function

    +

    ▸ (): void

    +
    +

    Optional step#

    +

    step? : number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:19

    +
    +

    Optional title#

    +

    title? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:20

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html new file mode 100644 index 0000000000..9641fa789b --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -0,0 +1,1352 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardStepProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Interface: WizardStepProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • WizardCommonProps‹D›
    • +
    +

    WizardStepProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional afterContent#

    +

    afterContent? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:122

    +
    +

    Optional beforeContent#

    +

    beforeContent? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:121

    +
    +

    Optional className#

    +

    className? : string | object

    +

    Defined in src/renderer/components/wizard/wizard.tsx:103

    +
    +

    Optional contentClass#

    +

    contentClass? : string | object

    +

    Defined in src/renderer/components/wizard/wizard.tsx:104

    +
    +

    Optional customButtons#

    +

    customButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:105

    +
    +

    Optional data#

    +

    data? : Partial‹D›

    +

    Inherited from WizardProps.data

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +
    +

    Optional disabledNext#

    +

    disabledNext? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:109

    +
    +

    Optional done#

    +

    done? : function

    +

    Inherited from WizardProps.done

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional first#

    +

    first? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:117

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional hideBackBtn#

    +

    hideBackBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:111

    +
    +

    Optional hideNextBtn#

    +

    hideNextBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:110

    +
    +

    Optional hideSteps#

    +

    hideSteps? : boolean

    +

    Inherited from WizardProps.hideSteps

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +
    +

    Optional isFirst#

    +

    isFirst? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:119

    +

    Type declaration:#

    +

    ▸ (): boolean

    +
    +

    Optional isLast#

    +

    isLast? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:120

    +

    Type declaration:#

    +

    ▸ (): boolean

    +
    +

    Optional last#

    +

    last? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:118

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional loading#

    +

    loading? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:107

    +
    +

    Optional moreButtons#

    +

    moreButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:106

    +
    +

    Optional next#

    +

    next? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:115

    +

    Type declaration:#

    +

    ▸ (): void | boolean | Promise‹any›

    +
    +

    Optional nextLabel#

    +

    nextLabel? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:114

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:123

    +
    +

    Optional prev#

    +

    prev? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:116

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional prevLabel#

    +

    prevLabel? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:113

    +
    +

    Optional reset#

    +

    reset? : function

    +

    Inherited from WizardProps.reset

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Type declaration:#

    +

    ▸ (): void

    +
    +

    Optional save#

    +

    save? : function

    +

    Inherited from WizardProps.save

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Type declaration:#

    +

    ▸ (data: Partial‹D›, callback?: function): void

    +

    Parameters:

    +

    data: Partial‹D›

    +

    Optional callback: function

    +

    ▸ (): void

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:125

    +
    +

    Optional skip#

    +

    skip? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:124

    +
    +

    Optional step#

    +

    step? : number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:112

    +
    +

    Optional title#

    +

    title? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:102

    +
    +

    Optional waiting#

    +

    waiting? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:108

    +
    +

    Optional wizard#

    +

    wizard? : Wizard

    +

    Defined in src/renderer/components/wizard/wizard.tsx:101

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html new file mode 100644 index 0000000000..8ca7308e81 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IKubeApiCluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html new file mode 100644 index 0000000000..7eaac62770 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -0,0 +1,1132 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainer - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IPodContainer#

    +

    Hierarchy#

    +
      +
    • IPodContainer
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional args#

    +

    args? : string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:69

    +
    +

    Optional command#

    +

    command? : string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:68

    +
    +

    Optional env#

    +

    env? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:85

    +
    +

    Optional envFrom#

    +

    envFrom? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:103

    +
    +

    image#

    +

    image: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:67

    +
    +

    imagePullPolicy#

    +

    imagePullPolicy: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:119

    +
    +

    Optional livenessProbe#

    +

    livenessProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:116

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    +
    +

    Optional ports#

    +

    ports? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:70

    +
    +

    Optional readinessProbe#

    +

    readinessProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:117

    +
    +

    Optional resources#

    +

    resources? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    +

    Type declaration:#

    +
      +
    • +

      limits(): object

      +
    • +
    • +

      cpu: string

      +
    • +
    • +

      memory: string

      +
    • +
    • +

      requests(): object

      +
    • +
    • +

      cpu: string

      +
    • +
    • +

      memory: string

      +
    • +
    +
    +

    Optional startupProbe#

    +

    startupProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:118

    +
    +

    Optional volumeMounts#

    +

    volumeMounts? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:111

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html new file mode 100644 index 0000000000..21a3370957 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html @@ -0,0 +1,1135 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainerStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IPodContainerStatus#

    +

    Hierarchy#

    +
      +
    • IPodContainerStatus
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional containerID#

    +

    containerID? : string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:180

    +
    +

    image#

    +

    image: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:178

    +
    +

    imageID#

    +

    imageID: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:179

    +
    +

    Optional lastState#

    +

    lastState? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:160

    +

    Type declaration:#

    +
      +
    • +

      [ index: string]: object

      +
    • +
    • +

      running(): object

      +
    • +
    • +

      startedAt: string

      +
    • +
    • +

      terminated(): object

      +
    • +
    • +

      exitCode: number

      +
    • +
    • +

      finishedAt: string

      +
    • +
    • +

      reason: string

      +
    • +
    • +

      startedAt: string

      +
    • +
    • +

      waiting(): object

      +
    • +
    • +

      message: string

      +
    • +
    • +

      reason: string

      +
    • +
    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:143

    +
    +

    ready#

    +

    ready: boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:176

    +
    +

    restartCount#

    +

    restartCount: number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:177

    +
    +

    Optional started#

    +

    started? : boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:181

    +
    +

    Optional state#

    +

    state? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:144

    +

    Type declaration:#

    +
      +
    • +

      [ index: string]: object

      +
    • +
    • +

      running(): object

      +
    • +
    • +

      startedAt: string

      +
    • +
    • +

      terminated(): object

      +
    • +
    • +

      exitCode: number

      +
    • +
    • +

      finishedAt: string

      +
    • +
    • +

      reason: string

      +
    • +
    • +

      startedAt: string

      +
    • +
    • +

      waiting(): object

      +
    • +
    • +

      message: string

      +
    • +
    • +

      reason: string

      +
    • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html new file mode 100644 index 0000000000..f9a05d2b8a --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ISecretRef - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html new file mode 100644 index 0000000000..9770f9e7a8 --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -0,0 +1,1001 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IURLParams ‹**P, Q**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html b/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html new file mode 100644 index 0000000000..614ea2fbba --- /dev/null +++ b/v4.2.1/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParamInit ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageParamInit ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParamInit
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional defaultValue#

    +

    defaultValue? : V

    +

    Defined in src/renderer/navigation/page-param.ts:6

    +
    +

    Optional defaultValueStringified#

    +

    defaultValueStringified? : string | string[]

    +

    Defined in src/renderer/navigation/page-param.ts:7

    +
    +

    Optional multiValueSep#

    +

    multiValueSep? : string

    +

    Defined in src/renderer/navigation/page-param.ts:9

    +
    +

    Optional multiValues#

    +

    multiValues? : boolean

    +

    Defined in src/renderer/navigation/page-param.ts:8

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/navigation/page-param.ts:5

    +
    +

    Optional skipEmpty#

    +

    skipEmpty? : boolean

    +

    Defined in src/renderer/navigation/page-param.ts:10

    +

    Methods#

    +

    Optional parse#

    +

    parse(value: string[]): V

    +

    Defined in src/renderer/navigation/page-param.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring[]
    +

    Returns: V

    +
    +

    Optional stringify#

    +

    stringify(value: V): string | string[]

    +

    Defined in src/renderer/navigation/page-param.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueV
    +

    Returns: string | string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_core_api_app_/index.html b/v4.2.1/extensions/api/modules/_core_api_app_/index.html new file mode 100644 index 0000000000..3cb58b2b0b --- /dev/null +++ b/v4.2.1/extensions/api/modules/_core_api_app_/index.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/app" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/app"#

    +

    Index#

    +

    Variables#

    + +

    Functions#

    + +

    Variables#

    +

    Const appName#

    +

    appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

    +

    Defined in src/common/vars.ts:15

    +
    +

    Const isLinux#

    +

    isLinux: boolean = process.platform === "linux"

    +

    Defined in src/common/vars.ts:8

    +
    +

    Const isMac#

    +

    isMac: boolean = process.platform === "darwin"

    +

    Defined in src/common/vars.ts:6

    +
    +

    Const isSnap#

    +

    isSnap: boolean = !!process.env.SNAP

    +

    Defined in src/common/vars.ts:10

    +
    +

    Const isWindows#

    +

    isWindows: boolean = process.platform === "win32"

    +

    Defined in src/common/vars.ts:7

    +
    +

    Const issuesTrackerUrl#

    +

    issuesTrackerUrl: "https://github.com/lensapp/lens/issues" = "https://github.com/lensapp/lens/issues"

    +

    Defined in src/common/vars.ts:43

    +
    +

    Const slackUrl#

    +

    slackUrl: "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI" = "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI"

    +

    Defined in src/common/vars.ts:44

    +
    +

    Const version#

    +

    version: string = getAppVersion()

    +

    Defined in src/extensions/core-api/app.ts:4

    +

    Functions#

    +

    getEnabledExtensions#

    +

    getEnabledExtensions(): string[]

    +

    Defined in src/extensions/core-api/app.ts:7

    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_core_api_cluster_feature_/index.html b/v4.2.1/extensions/api/modules/_core_api_cluster_feature_/index.html new file mode 100644 index 0000000000..fe8e115662 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -0,0 +1,943 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/cluster-feature" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_core_api_event_bus_/index.html b/v4.2.1/extensions/api/modules/_core_api_event_bus_/index.html new file mode 100644 index 0000000000..dee726390b --- /dev/null +++ b/v4.2.1/extensions/api/modules/_core_api_event_bus_/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/event-bus" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/event-bus"#

    +

    Index#

    +

    Type aliases#

    + +

    Variables#

    + +

    Type aliases#

    +

    AppEvent#

    +

    Ƭ AppEvent: object

    +

    Defined in src/common/event-bus.ts:3

    +

    Type declaration:#

    +
      +
    • +

      action: string

      +
    • +
    • +

      name: string

      +
    • +
    • +

      params? : object

      +
    • +
    +

    Variables#

    +

    Const appEventBus#

    +

    appEventBus: EventEmitter‹[object]› = new EventEmitter<[AppEvent]>()

    +

    Defined in src/common/event-bus.ts:9

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_core_api_stores_/index.html b/v4.2.1/extensions/api/modules/_core_api_stores_/index.html new file mode 100644 index 0000000000..4662901710 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_core_api_stores_/index.html @@ -0,0 +1,1042 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/stores" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/stores"#

    +

    Index#

    +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Type aliases#

    +

    ClusterId#

    +

    Ƭ ClusterId: string

    +

    Defined in src/common/cluster-store.ts:41

    +
    +

    WorkspaceId#

    +

    Ƭ WorkspaceId: string

    +

    Defined in src/common/workspace-store.ts:10

    +

    Variables#

    +

    Const clusterStore#

    +

    clusterStore: ClusterStore‹› = ClusterStore.getInstance()

    +

    Defined in src/extensions/stores/cluster-store.ts:124

    +
    +

    Const workspaceStore#

    +

    workspaceStore: WorkspaceStore‹› = WorkspaceStore.getInstance()

    +

    Defined in src/extensions/stores/workspace-store.ts:118

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_core_api_utils_/index.html b/v4.2.1/extensions/api/modules/_core_api_utils_/index.html new file mode 100644 index 0000000000..293a4be0f8 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_core_api_utils_/index.html @@ -0,0 +1,1072 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/utils" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/utils"#

    +

    Index#

    +

    Classes#

    + +

    Functions#

    + +

    Functions#

    +

    cssNames#

    +

    cssNames(...args: IClassName[]): string

    +

    Defined in src/renderer/utils/cssNames.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsIClassName[]
    +

    Returns: string

    +
    +

    openExternal#

    +

    openExternal(url: string): Promise‹void›

    +

    Defined in src/common/utils/openExternal.ts:4

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    urlstring
    +

    Returns: Promise‹void›

    +
    +

    prevDefault#

    +

    prevDefaultE›(callback: function): (Anonymous function)

    +

    Defined in src/renderer/utils/prevDefault.ts:15

    +

    Type parameters:

    +

    E: SyntheticEvent | Event

    +

    Parameters:

    +

    callback: function

    +

    ▸ (evt: E): any

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtE
    +

    Returns: (Anonymous function)

    +
    +

    stopPropagation#

    +

    stopPropagation(evt: Event | SyntheticEvent): void

    +

    Defined in src/renderer/utils/prevDefault.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtEvent | SyntheticEvent
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_interfaces_index_/index.html b/v4.2.1/extensions/api/modules/_interfaces_index_/index.html new file mode 100644 index 0000000000..6799317b4a --- /dev/null +++ b/v4.2.1/extensions/api/modules/_interfaces_index_/index.html @@ -0,0 +1,953 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "interfaces/index" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + + +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_renderer_api_components_/index.html b/v4.2.1/extensions/api/modules/_renderer_api_components_/index.html new file mode 100644 index 0000000000..f7d2cc05c2 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_renderer_api_components_/index.html @@ -0,0 +1,1674 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/components" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Module: "renderer-api/components"#

    +

    Index#

    +

    Enumerations#

    + +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Functions#

    + +

    Type aliases#

    +

    InputProps#

    +

    Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object

    +

    Defined in src/renderer/components/input/input.tsx:21

    +
    + +

    Ƭ MenuContextValue: Menu

    +

    Defined in src/renderer/components/menu/menu.tsx:11

    +
    +

    NotificationId#

    +

    Ƭ NotificationId: string | number

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:7

    +
    +

    NotificationMessage#

    +

    Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:8

    +
    +

    RadioProps#

    +

    Ƭ RadioProps: HTMLProps‹any› & object

    +

    Defined in src/renderer/components/radio/radio.tsx:40

    +
    +

    TableCellElem#

    +

    Ƭ TableCellElem: ReactElement‹TableCellProps

    +

    Defined in src/renderer/components/table/table-cell.tsx:9

    +
    +

    TableHeadElem#

    +

    Ƭ TableHeadElem: ReactElement‹TableHeadProps

    +

    Defined in src/renderer/components/table/table-head.tsx:6

    +
    +

    TableOrderBy#

    +

    Ƭ TableOrderBy: "asc" | "desc" | string

    +

    Defined in src/renderer/components/table/table.tsx:17

    +
    +

    TableRowElem#

    +

    Ƭ TableRowElem: ReactElement‹TableRowProps

    +

    Defined in src/renderer/components/table/table-row.tsx:7

    +
    +

    TableSortBy#

    +

    Ƭ TableSortBy: string

    +

    Defined in src/renderer/components/table/table.tsx:16

    +
    +

    TableSortCallback#

    +

    Ƭ TableSortCallback: function

    +

    Defined in src/renderer/components/table/table.tsx:19

    +

    Type declaration:#

    +

    ▸ (data: D): string | number | (string | number)[]

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataD
    +
    +

    TableSortCallbacks#

    +

    Ƭ TableSortCallbacks: object

    +

    Defined in src/renderer/components/table/table.tsx:20

    +

    Type declaration:#

    + +
    +

    TableSortParams#

    +

    Ƭ TableSortParams: object

    +

    Defined in src/renderer/components/table/table.tsx:18

    +

    Type declaration:#

    + +

    Variables#

    +

    InputValidators#

    +

    InputValidators: InputValidators

    +

    Defined in src/renderer/components/input/input.tsx:14

    +
    +

    Const MenuContext#

    +

    MenuContext: Context‹Menu‹›› = React.createContext(null)

    +

    Defined in src/renderer/components/menu/menu.tsx:10

    +
    +

    Const TabLayout#

    +

    TabLayout: (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { + const currentLocation = navigation.location.pathname; + const hasTabs = tabs.length > 0; + const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null;

    +

    return ( +

    + {hasTabs && ( + navigate(url)}> + {tabs.map(({ title, routePath, url = routePath, exact }) => { + const isActive = !!matchPath(currentLocation, { path: routePath, exact });

    +
            return <Tab key={url} label={title} value={url} active={isActive}/>;
    +      })}
    +    </Tabs>
    +  )}
    +  <main className={cssNames(contentClass)}>
    +    <ErrorBoundary>
    +      {hasTabs && (
    +        <Switch>
    +          {tabs.map(({ routePath, exact, component }) => {
    +            return <Route key={routePath} exact={exact} path={routePath} component={component}/>;
    +          })}
    +          <Redirect to={startTabUrl}/>
    +        </Switch>
    +      )}
    +      {children}
    +    </ErrorBoundary>
    +  </main>
    +</div>
    +
    +

    ); +})

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:27

    +
    +

    Const kubeDetailsUrlParam#

    +

    kubeDetailsUrlParam: PageParam‹string› = createPageParam({ + name: "kube-details", + isSystem: true, +})

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:19

    +

    Used to store object.selfLink to show more info about resource in the details panel.

    +
    +

    Const kubeSelectedUrlParam#

    +

    kubeSelectedUrlParam: PageParam‹string› = createPageParam({ + name: "kube-selected", + isSystem: true, + get defaultValue() { + return kubeDetailsUrlParam.get(); + } +})

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:31

    +

    Used to highlight last active/selected table row with the resource.

    +

    example +If we go to "Nodes (page) -> Node (details) -> Pod (details)", +last clicked Node should be "active" while Pod details are shown).

    +
    +

    Const logTabStore#

    +

    logTabStore: LogTabStore‹› = new LogTabStore()

    +

    Defined in src/renderer/components/dock/log-tab.store.ts:119

    +
    +

    Const notificationsStore#

    +

    notificationsStore: NotificationsStore‹› = new NotificationsStore()

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:78

    +
    +

    Const orderByUrlParam#

    +

    orderByUrlParam: PageParam‹string› = createPageParam({ + name: "order", + isSystem: true, +})

    +

    Defined in src/renderer/components/table/table.tsx:52

    +
    +

    Const sortByUrlParam#

    +

    sortByUrlParam: PageParam‹string› = createPageParam({ + name: "sort", + isSystem: true, +})

    +

    Defined in src/renderer/components/table/table.tsx:47

    +
    +

    Const terminalStore#

    +

    terminalStore: TerminalStore‹› = new TerminalStore()

    +

    Defined in src/renderer/components/dock/terminal.store.ts:122

    +

    Functions#

    +

    DrawerItemLabels#

    +

    DrawerItemLabels(props: DrawerItemLabelsProps): Element‹›

    +

    Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsDrawerItemLabelsProps
    +

    Returns: Element‹›

    +
    + +

    SubMenu(props: Partial‹MenuProps›): Element‹›

    +

    Defined in src/renderer/components/menu/menu.tsx:289

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsPartial‹MenuProps
    +

    Returns: Element‹›

    +
    +

    createTerminalTab#

    +

    createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

    +

    Defined in src/renderer/components/dock/terminal.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    tabParamsPartial‹ITerminalTab›{}
    +

    Returns: IDockTab

    +
    +

    getDetailsUrl#

    +

    getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    selfLinkstring-
    resetSelectedbooleanfalse
    mergeGlobalsbooleantrue
    +

    Returns: string

    +
    +

    hideDetails#

    +

    hideDetails(): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    +

    Returns: void

    +
    +

    showDetails#

    +

    showDetails(selfLink: string, resetSelected: boolean): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    selfLinkstring""
    resetSelectedbooleantrue
    +

    Returns: void

    +
    +

    withTooltip#

    +

    withTooltipT›(Target: T): T

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:18

    +

    Type parameters:

    +

    T: React.ComponentType‹any›

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    TargetT
    +

    Returns: T

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_renderer_api_k8s_api_/index.html b/v4.2.1/extensions/api/modules/_renderer_api_k8s_api_/index.html new file mode 100644 index 0000000000..12c6af23f0 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -0,0 +1,1599 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/k8s-api" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Module: "renderer-api/k8s-api"#

    +

    Index#

    +

    Enumerations#

    + +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Functions#

    + +

    Type aliases#

    +

    KubeObjectStatus#

    +

    Ƭ KubeObjectStatus: object

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:1

    +

    Type declaration:#

    + +

    Variables#

    +

    Const apiManager#

    +

    apiManager: ApiManager‹› = new ApiManager()

    +

    Defined in src/renderer/api/api-manager.ts:64

    +
    +

    Const clusterRoleApi#

    +

    clusterRoleApi: KubeApiClusterRole‹›› = new KubeApi({ + objectConstructor: ClusterRole, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:12

    +
    +

    Const clusterRoleBindingApi#

    +

    clusterRoleBindingApi: KubeApiClusterRoleBinding‹›› = new KubeApi({ + objectConstructor: ClusterRoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10

    +
    +

    Const configMapApi#

    +

    configMapApi: KubeApiConfigMap‹›› = new KubeApi({ + objectConstructor: ConfigMap, +})

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:26

    +
    +

    Const crdApi#

    +

    crdApi: KubeApiCustomResourceDefinition‹›› = new KubeApi({ + objectConstructor: CustomResourceDefinition, + checkPreferredVersion: true, +})

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:154

    +
    +

    Const cronJobApi#

    +

    cronJobApi: CronJobApi‹› = new CronJobApi({ + objectConstructor: CronJob, +})

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:131

    +
    +

    Const daemonSetApi#

    +

    daemonSetApi: KubeApiDaemonSet‹›› = new KubeApi({ + objectConstructor: DaemonSet, +})

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:74

    +
    +

    Const deploymentApi#

    +

    deploymentApi: DeploymentApi‹› = new DeploymentApi({ + objectConstructor: Deployment, +})

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:192

    +
    +

    Const endpointApi#

    +

    endpointApi: KubeApiEndpoint‹›› = new KubeApi({ + objectConstructor: Endpoint, +})

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:127

    +
    +

    Const eventApi#

    +

    eventApi: KubeApiKubeEvent‹›› = new KubeApi({ + objectConstructor: KubeEvent, +})

    +

    Defined in src/renderer/api/endpoints/events.api.ts:59

    +
    +

    Const hpaApi#

    +

    hpaApi: KubeApiHorizontalPodAutoscaler‹›› = new KubeApi({ + objectConstructor: HorizontalPodAutoscaler, +})

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:143

    +
    +

    Const ingressApi#

    +

    ingressApi: IngressApi‹› = new IngressApi({ + objectConstructor: Ingress, + // Add fallback for Kubernetes <1.19 + checkPreferredVersion: true, + fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], + logStuff: true +} as any)

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:177

    +
    +

    Const jobApi#

    +

    jobApi: KubeApiJob‹›› = new KubeApi({ + objectConstructor: Job, +})

    +

    Defined in src/renderer/api/endpoints/job.api.ts:110

    +
    +

    Const limitRangeApi#

    +

    limitRangeApi: KubeApiLimitRange‹›› = new KubeApi({ + objectConstructor: LimitRange, +})

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:55

    +
    +

    Const namespacesApi#

    +

    namespacesApi: KubeApiNamespace‹›› = new KubeApi({ + objectConstructor: Namespace, +})

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:25

    +
    +

    Const networkPolicyApi#

    +

    networkPolicyApi: KubeApiNetworkPolicy‹›› = new KubeApi({ + objectConstructor: NetworkPolicy, +})

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:71

    +
    +

    Const nodesApi#

    +

    nodesApi: NodesApi‹› = new NodesApi({ + objectConstructor: Node, +})

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:169

    +
    +

    Const pdbApi#

    +

    pdbApi: KubeApiPodDisruptionBudget‹›› = new KubeApi({ + objectConstructor: PodDisruptionBudget, +})

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47

    +
    +

    Const persistentVolumeApi#

    +

    persistentVolumeApi: KubeApiPersistentVolume‹›› = new KubeApi({ + objectConstructor: PersistentVolume, +})

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:79

    +
    +

    Const podsApi#

    +

    podsApi: PodsApi‹› = new PodsApi({ + objectConstructor: Pod, +})

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:469

    +
    +

    Const pvcApi#

    +

    pvcApi: PersistentVolumeClaimsApi‹› = new PersistentVolumeClaimsApi({ + objectConstructor: PersistentVolumeClaim, +})

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90

    +
    +

    Const replicaSetApi#

    +

    replicaSetApi: ReplicaSetApi‹› = new ReplicaSetApi({ + objectConstructor: ReplicaSet, +})

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:83

    +
    +

    Const resourceQuotaApi#

    +

    resourceQuotaApi: KubeApiResourceQuota‹›› = new KubeApi({ + objectConstructor: ResourceQuota, +})

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:66

    +
    +

    Const roleApi#

    +

    roleApi: KubeApiRole‹›› = new KubeApi({ + objectConstructor: Role, +})

    +

    Defined in src/renderer/api/endpoints/role.api.ts:21

    +
    +

    Const roleBindingApi#

    +

    roleBindingApi: KubeApiRoleBinding‹›› = new KubeApi({ + objectConstructor: RoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:34

    +
    +

    Const secretsApi#

    +

    secretsApi: KubeApiSecret‹›› = new KubeApi({ + objectConstructor: Secret, +})

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:48

    +
    +

    Const serviceAccountsApi#

    +

    serviceAccountsApi: KubeApiServiceAccount‹›› = new KubeApi({ + objectConstructor: ServiceAccount, +})

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:27

    +
    +

    Const serviceApi#

    +

    serviceApi: KubeApiService‹›› = new KubeApi({ + objectConstructor: Service, +})

    +

    Defined in src/renderer/api/endpoints/service.api.ts:101

    +
    +

    Const statefulSetApi#

    +

    statefulSetApi: StatefulSetApi‹› = new StatefulSetApi({ + objectConstructor: StatefulSet, +})

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:110

    +
    +

    Const storageClassApi#

    +

    storageClassApi: KubeApiStorageClass‹›› = new KubeApi({ + objectConstructor: StorageClass, +})

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:37

    +

    Functions#

    +

    forCluster#

    +

    forClusterT›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

    +

    Defined in src/renderer/api/kube-api.ts:68

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    clusterIKubeApiCluster
    kubeClassIKubeObjectConstructor‹T›
    +

    Returns: KubeApi‹T›

    +
    +

    isAllowedResource#

    +

    isAllowedResource(resources: KubeResource | KubeResource[]): boolean

    +

    Defined in src/common/rbac.ts:44

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcesKubeResource | KubeResource[]
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_renderer_api_navigation_/index.html b/v4.2.1/extensions/api/modules/_renderer_api_navigation_/index.html new file mode 100644 index 0000000000..bfa34f7c11 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_renderer_api_navigation_/index.html @@ -0,0 +1,1141 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/navigation" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "renderer-api/navigation"#

    +

    Index#

    +

    Classes#

    + +

    Interfaces#

    + +

    Functions#

    + +

    Functions#

    +

    createPageParam#

    +

    createPageParamV›(init: PageParamInit‹V›): PageParam‹V›

    +

    Defined in src/extensions/renderer-api/navigation.ts:10

    +

    Type parameters:

    +

    V

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    initPageParamInit‹V›
    +

    Returns: PageParam‹V›

    +
    +

    getDetailsUrl#

    +

    getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    selfLinkstring-
    resetSelectedbooleanfalse
    mergeGlobalsbooleantrue
    +

    Returns: string

    +
    +

    hideDetails#

    +

    hideDetails(): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

    +

    Returns: void

    +
    +

    isActiveRoute#

    +

    isActiveRoute(route: string | string[] | RouteProps): boolean

    +

    Defined in src/renderer/navigation/helpers.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    routestring | string[] | RouteProps
    +

    Returns: boolean

    +
    + +

    navigate(location: LocationDescriptor): void

    +

    Defined in src/renderer/navigation/helpers.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    locationLocationDescriptor
    +

    Returns: void

    +
    +

    showDetails#

    +

    showDetails(selfLink: string, resetSelected: boolean): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    selfLinkstring""
    resetSelectedbooleantrue
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/api/modules/_renderer_api_theming_/index.html b/v4.2.1/extensions/api/modules/_renderer_api_theming_/index.html new file mode 100644 index 0000000000..f0cab8bf33 --- /dev/null +++ b/v4.2.1/extensions/api/modules/_renderer_api_theming_/index.html @@ -0,0 +1,957 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/theming" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/capabilities/color-reference/index.html b/v4.2.1/extensions/capabilities/color-reference/index.html new file mode 100644 index 0000000000..07542acf80 --- /dev/null +++ b/v4.2.1/extensions/capabilities/color-reference/index.html @@ -0,0 +1,1301 @@ + + + + + + + + + + + + + + + + + + + + + + Color Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    Theme Color Reference#

    +

    You can use theme-based CSS Variables to style an extension according to the active theme.

    +

    Base Colors#

    +
      +
    • --blue: blue color.
    • +
    • --magenta: magenta color.
    • +
    • --golden: gold/yellow color.
    • +
    • --halfGray: gray with some apacity applied.
    • +
    • --primary: Lens brand (blue) color.
    • +
    • --colorSuccess: successfull operations color.
    • +
    • --colorOk: successfull operations (bright version) color.
    • +
    • --colorInfo: informational, in-progress color.
    • +
    • --colorError: critical error color.
    • +
    • --colorSoftError: error color.
    • +
    • --colorWarning: warning color.
    • +
    • --colorVague: soft gray color for notices, hints etc.
    • +
    • --colorTerminated: terminated, closed, stale color.
    • +
    • --boxShadow: semi-transparent box-shadow color.
    • +
    +

    Text Colors#

    +
      +
    • --textColorPrimary: foreground text color.
    • +
    • --textColorSecondary: foreground text color for different paragraps, parts of text.
    • +
    • --textColorAccent: foreground text color to highlight its parts.
    • +
    +

    Border Colors#

    +
      +
    • --borderColor: border color.
    • +
    • --borderFaintColor: fainted (lighter or darker, which depends on the theme) border color.
    • +
    +

    Layout Colors#

    +
      +
    • --mainBackground: main background color for the app.
    • +
    • --contentColor: background color for panels contains some data.
    • +
    • --layoutBackground: background color for layout parts.
    • +
    • --layoutTabsBackground: background color for general tabs.
    • +
    • --layoutTabsActiveColor: foreground color for general tabs.
    • +
    • --layoutTabsLineColor: background color for lines under general tabs.
    • +
    + +
      +
    • --sidebarLogoBackground: background color behind logo in sidebar.
    • +
    • --sidebarActiveColor: foreground color for active menu items in sidebar.
    • +
    • --sidebarSubmenuActiveColor: foreground color for active submenu items in sidebar.
    • +
    • --sidebarBackground: background color for sidebar.
    • +
    +

    Button Colors#

    +
      +
    • --buttonPrimaryBackground: button background color for primary actions.
    • +
    • --buttonDefaultBackground: default button background color.
    • +
    • --buttonLightBackground: light button background color.
    • +
    • --buttonAccentBackground: accent button background color.
    • +
    • --buttonDisabledBackground: disabled button background color.
    • +
    +

    Table Colors#

    +
      +
    • --tableBgcStripe: background color for odd rows in table.
    • +
    • --tableBgcSelected: background color for selected row in table.
    • +
    • --tableHeaderBackground: background color for table header.
    • +
    • --tableHeaderBorderWidth: border width under table header.
    • +
    • --tableHeaderBorderColor: border color for line under table header.
    • +
    • --tableHeaderColor: foreground color for table header.
    • +
    • --tableSelectedRowColor: foreground color for selected row in table.
    • +
    +

    Dock Colors#

    +
      +
    • --dockHeadBackground: background color for dock's header.
    • +
    • --dockInfoBackground: background color for dock's info panel.
    • +
    • --dockInfoBorderColor: border color for dock's info panel.
    • +
    +

    Helm Chart Colors#

    +
      +
    • --helmLogoBackground: background color for chart logo.
    • +
    • --helmImgBackground: background color for chart image.
    • +
    • --helmStableRepo: background color for stable repo.
    • +
    • --helmIncubatorRepo: background color for incubator repo.
    • +
    • --helmDescriptionHr: Helm chart description separator line color.
    • +
    • --helmDescriptionBlockqouteColor: Helm chart description blockquote color.
    • +
    • --helmDescriptionBlockqouteBorder: Helm chart description blockquote border color.
    • +
    • --helmDescriptionBlockquoteBackground: Helm chart description blockquote background color.
    • +
    • --helmDescriptionHeaders: Helm chart description headers color.
    • +
    • --helmDescriptionH6: Helm chart description header foreground color.
    • +
    • --helmDescriptionTdBorder: Helm chart description table cell border color.
    • +
    • --helmDescriptionTrBackground: Helm chart description table row background color.
    • +
    • --helmDescriptionCodeBackground: Helm chart description code background color.
    • +
    • --helmDescriptionPreBackground: Helm chart description pre background color.
    • +
    • --helmDescriptionPreColor: Helm chart description pre foreground color.
    • +
    +

    Terminal Colors#

    +
      +
    • --terminalBackground: Terminal background color.
    • +
    • --terminalForeground: Terminal foreground color.
    • +
    • --terminalCursor: Terminal cursor color.
    • +
    • --terminalCursorAccent: Terminal cursor accent color.
    • +
    • --terminalSelection: Terminal selection background color.
    • +
    • --terminalBlack: Terminal black color.
    • +
    • --terminalRed: Terminal red color.
    • +
    • --terminalGreen: Terminal green color.
    • +
    • --terminalYellow: Terminal yellow color.
    • +
    • --terminalBlue: Terminal blue color.
    • +
    • --terminalMagenta: Terminal magenta color.
    • +
    • --terminalCyan: Terminal cyan color.
    • +
    • --terminalWhite: Terminal white color.
    • +
    • --terminalBrightBlack: Terminal bright black color.
    • +
    • --terminalBrightRed: Terminal bright red color.
    • +
    • --terminalBrightGreen: Terminal bright green color.
    • +
    • --terminalBrightYellow: Terminal bright yellow color.
    • +
    • --terminalBrightBlue: Terminal bright blue color.
    • +
    • --terminalBrightMagenta: Terminal bright magenta color.
    • +
    • --terminalBrightCyan: Terminal bright cyan color.
    • +
    • --terminalBrightWhite: Terminal bright white color.
    • +
    +

    Dialog Colors#

    +
      +
    • --dialogHeaderBackground: background color for dialog header.
    • +
    • --dialogFooterBackground: background color for dialog footer.
    • +
    +

    Detail Panel (Drawer) Colors#

    +
      +
    • --drawerTitleText: drawer title foreground color.
    • +
    • --drawerSubtitleBackground: drawer subtitle foreground color.
    • +
    • --drawerItemNameColor: foreground color for item name in drawer.
    • +
    • --drawerItemValueColor: foreground color for item value in drawer.
    • +
    +

    Misc Colors#

    +
      +
    • --logsBackground: background color for pod logs.
    • +
    • --clusterMenuBackground: background color for cluster menu.
    • +
    • --clusterMenuBorderColor: border color for cluster menu.
    • +
    • --clusterSettingsBackground: background color for cluster settings.
    • +
    • --addClusterIconColor: add cluster button background color.
    • +
    • --iconActiveColor: active cluster icon foreground color.
    • +
    • --iconActiveBackground: active cluster icon background color.
    • +
    • --filterAreaBackground: page filter area (where selected namespaces are lister) background color.
    • +
    • --chartStripesColor: bar chart zebra stripes background color.
    • +
    • --chartCapacityColor: background color for capacity values in bar charts.
    • +
    • --pieChartDefaultColor: default background color for pie chart values.
    • +
    • --selectOptionHoveredColor: foregrond color for selected element in dropdown list.
    • +
    • --lineProgressBackground: background color for progress line.
    • +
    • --radioActiveBackground: background color for active radio buttons.
    • +
    • --menuActiveBackground: background color for active menu items.
    • +
    +

    In most cases you would only need base, text and some of the layout colors.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/capabilities/common-capabilities/index.html b/v4.2.1/extensions/capabilities/common-capabilities/index.html new file mode 100644 index 0000000000..ff02f44f32 --- /dev/null +++ b/v4.2.1/extensions/capabilities/common-capabilities/index.html @@ -0,0 +1,1413 @@ + + + + + + + + + + + + + + + + + + + + + + Common Capabilities - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Common Capabilities#

    +

    Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.

    +

    Main Extension#

    +

    The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.

    +

    Activate#

    +

    This extension can register a custom callback that is executed when an extension is activated (started).

    +
    import { LensMainExtension } from "@k8slens/extensions"
    +
    +export default class ExampleMainExtension extends LensMainExtension {
    +  async onActivate() {
    +    console.log("hello world")
    +  }
    +}
    +
    +

    Deactivate#

    +

    This extension can register a custom callback that is executed when an extension is deactivated (stopped).

    +
    import { LensMainExtension } from "@k8slens/extensions"
    +
    +export default class ExampleMainExtension extends LensMainExtension {
    +  async onDeactivate() {
    +    console.log("bye bye")
    +  }
    +}
    +
    +

    App Menus#

    +

    This extension can register custom app menus that will be displayed on OS native menus.

    +

    Example:

    +
    import { LensMainExtension, windowManager } from "@k8slens/extensions"
    +
    +export default class ExampleMainExtension extends LensMainExtension {
    +  appMenus = [
    +    {
    +      parentId: "help",
    +      label: "Example item",
    +      click() {
    +        windowManager.navigate("https://k8slens.dev");
    +      }
    +    }
    +  ]
    +}
    +
    +

    Renderer Extension#

    +

    The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.

    +

    Activate#

    +

    This extension can register a custom callback that is executed when an extension is activated (started).

    +
    import { LensRendererExtension } from "@k8slens/extensions"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  async onActivate() {
    +    console.log("hello world")
    +  }
    +}
    +
    +

    Deactivate#

    +

    This extension can register a custom callback that is executed when an extension is deactivated (stopped).

    +
    import { LensRendererExtension } from "@k8slens/extensions"
    +
    +export default class ExampleMainExtension extends LensRendererExtension {
    +  async onDeactivate() {
    +    console.log("bye bye")
    +  }
    +}
    +
    +

    Global Pages#

    +

    This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.

    +
    import React from "react"
    +import { Component, LensRendererExtension } from "@k8slens/extensions"
    +import { ExamplePage } from "./src/example-page"
    +
    +export default class ExampleRendererExtension extends LensRendererExtension {
    +  globalPages = [
    +    {
    +      id: "example",
    +      components: {
    +        Page: ExamplePage,
    +      }
    +    }
    +  ]
    +
    +  globalPageMenus = [
    +    {
    +      title: "Example page", // used in icon's tooltip
    +      target: { pageId: "example" }
    +      components: {
    +        Icon: () => <Component.Icon material="arrow"/>,
    +      }
    +    }
    +  ]
    +}
    +
    +

    App Preferences#

    +

    This extension can register custom app preferences. It is responsible for storing a state for custom preferences.

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions"
    +import { myCustomPreferencesStore } from "./src/my-custom-preferences-store"
    +import { MyCustomPreferenceHint, MyCustomPreferenceInput } from "./src/my-custom-preference"
    +
    +
    +export default class ExampleRendererExtension extends LensRendererExtension {
    +  appPreferences = [
    +    {
    +      title: "My Custom Preference",
    +      components: {
    +        Hint: () => <MyCustomPreferenceHint/>,
    +        Input: () => <MyCustomPreferenceInput store={myCustomPreferencesStore}/>
    +      }
    +    }
    +  ]
    +}
    +
    +

    Cluster Pages#

    +

    This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExampleIcon, ExamplePage } from "./src/page"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterPages = [
    +    {
    +      id: "extension-example", // optional
    +      exact: true, // optional
    +      components: {
    +        Page: () => <ExamplePage extension={this}/>,
    +      }
    +    }
    +  ]
    +
    +  clusterPageMenus = [
    +    {
    +      url: "/extension-example", // optional
    +      title: "Example Extension",
    +      components: {
    +        Icon: ExampleIcon,
    +      }
    +    }
    +  ]
    +}
    +
    +

    Cluster Features#

    +

    This extension can register installable features for a cluster. These features are visible in the "Cluster Settings" page.

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions"
    +import { MyCustomFeature } from "./src/my-custom-feature"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterFeatures = [
    +    {
    +      title: "My Custom Feature",
    +      components: {
    +        Description: () => {
    +          return (
    +            <span>
    +              Just an example.
    +            </span>
    +          )
    +        }
    +      },
    +      feature: new MyCustomFeature()
    +    }
    +  ]
    +}
    +
    +

    Status Bar Items#

    +

    This extension can register custom icons and text to a status bar area.

    +
    import React from "react";
    +import { Component, LensRendererExtension, Navigation } from "@k8slens/extensions";
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  statusBarItems = [
    +    {
    +      components: {
    +        Item: (
    +          <div className="flex align-center gaps hover-highlight" onClick={() => this.navigate("/example-page")} >
    +            <Component.Icon material="favorite" />
    +          </div>
    +        )
    +      }
    +    }
    +  ]
    +}
    +
    +

    Kubernetes Object Menu Items#

    +

    This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions";
    +import { CustomMenuItem, CustomMenuItemProps } from "./src/custom-menu-item"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  kubeObjectMenuItems = [
    +    {
    +      kind: "Node",
    +      apiVersions: ["v1"],
    +      components: {
    +        MenuItem: (props: CustomMenuItemProps) => <CustomMenuItem {...props} />
    +      }
    +    }
    +  ]
    +}
    +
    +

    Kubernetes Object Details#

    +

    This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions";
    +import { CustomKindDetails, CustomKindDetailsProps } from "./src/custom-kind-details"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  kubeObjectDetailItems = [
    +    {
    +      kind: "CustomKind",
    +      apiVersions: ["custom.acme.org/v1"],
    +      components: {
    +        Details: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />
    +      }
    +    }
    +  ]
    +}
    +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/capabilities/images/css-vars-in-devtools.png b/v4.2.1/extensions/capabilities/images/css-vars-in-devtools.png new file mode 100644 index 0000000000..a9df97e6bb Binary files /dev/null and b/v4.2.1/extensions/capabilities/images/css-vars-in-devtools.png differ diff --git a/v4.2.1/extensions/capabilities/images/theme-selector.png b/v4.2.1/extensions/capabilities/images/theme-selector.png new file mode 100644 index 0000000000..5c2eba3165 Binary files /dev/null and b/v4.2.1/extensions/capabilities/images/theme-selector.png differ diff --git a/v4.2.1/extensions/capabilities/index.html b/v4.2.1/extensions/capabilities/index.html new file mode 100644 index 0000000000..5cebb5a80e --- /dev/null +++ b/v4.2.1/extensions/capabilities/index.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + Index - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + +

    Index

    + + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/capabilities/styling/index.html b/v4.2.1/extensions/capabilities/styling/index.html new file mode 100644 index 0000000000..b0d10f31aa --- /dev/null +++ b/v4.2.1/extensions/capabilities/styling/index.html @@ -0,0 +1,1225 @@ + + + + + + + + + + + + + + + + + + + + + + Styling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Styling an Extension#

    +

    Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.

    +

    Layout#

    +

    For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties:

    +
    <div className="flex column align-center"></div>
    +
    +
    div {
    +  display: flex;
    +  flex-direction: column;
    +  align-items: center;
    +}
    +
    +

    However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.

    +

    Layout Variables#

    +

    There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss:

    +
    --unit: 8px;
    +--padding: var(--unit);
    +--margin: var(--unit);
    +--border-radius: 3px;
    +
    +

    These variables are intended to set consistent margins and paddings across components. For example:

    +
    .status {
    +  padding-left: calc(var(--padding) * 2);
    +  border-radius: var(--border-radius);
    +}
    +
    +

    Themes#

    +

    Lens uses two built-in themes defined in the themes directory – one light and one dark.

    +

    Theme Variables#

    +

    When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables). This list then gets injected into the :root element so that any of the down-level components can use them. +CSS vars listed in devtools

    +

    When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones.

    +

    If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button, Select, Table, and so on.

    +

    There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss:

    +
    --font-main: 'Roboto', 'Helvetica', 'Arial', sans-serif;
    +--font-monospace: Lucida Console, Monaco, Consolas, monospace;
    +--font-size-small: calc(1.5 * var(--unit));
    +--font-size: calc(1.75 * var(--unit));
    +--font-size-big: calc(2 * var(--unit));
    +--font-weight-thin: 300;
    +--font-weight-normal: 400;
    +--font-weight-bold: 500;
    +
    +

    as well as in the theme modules:

    +
    --blue: #3d90ce;
    +--magenta: #c93dce;
    +--golden: #ffc63d;
    +--halfGray: #87909c80;
    +--primary: #3d90ce;
    +--textColorPrimary: #555555;
    +--textColorSecondary: #51575d;
    +--textColorAccent: #333333;
    +--borderColor: #c9cfd3;
    +--borderFaintColor: #dfdfdf;
    +--mainBackground: #f1f1f1;
    +--contentColor: #ffffff;
    +--layoutBackground: #e8e8e8;
    +--layoutTabsBackground: #f8f8f8;
    +--layoutTabsActiveColor: #333333;
    +--layoutTabsLineColor: #87909c80;
    +...
    +
    +

    These variables can be used in the following form: var(--magenta). For example:

    +
    .status {
    +  font-size: var(--font-size-small);
    +  background-color: var(--colorSuccess);
    +}
    +
    +

    A complete list of themable colors can be found in the Color Reference.

    +

    Theme Switching#

    +

    When the light theme is active, the <body> element gets a "theme-light" class, or: <body class="theme-light">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: +Color Theme

    +

    There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.

    +
    import React from "react"
    +import { observer } from "mobx-react"
    +import { App, Component, Theme } from "@k8slens/extensions";
    +
    +@observer
    +export class SupportPage extends React.Component {
    +  render() {
    +    return (
    +      <div className="SupportPage">
    +        <h1>Active theme is {Theme.getActiveTheme().name}</h1>
    +      </div>
    +    );
    +  }
    +}
    +
    +

    Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed.

    +

    Working example provided in Styling with Emotion sample extension.

    +

    Injected Styles#

    +

    Every extension is affected by the list of default global styles defined in app.scss. These are basic browser resets and element styles, including:

    +
      +
    • setting the box-sizing property for every element
    • +
    • default text and background colors
    • +
    • default font sizes
    • +
    • basic heading (h1, h2, etc) formatting
    • +
    • custom scrollbar styling
    • +
    +

    Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.

    +

    CSS-in-JS#

    +

    If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:

    +
    const Container = styled.div(() => ({
    +  backgroundColor: 'var(--mainBackground)'
    +}));
    +
    +

    Examples#

    +

    You can explore samples for each styling technique that you can use for extensions:

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/get-started/anatomy/index.html b/v4.2.1/extensions/get-started/anatomy/index.html new file mode 100644 index 0000000000..cb935cdd09 --- /dev/null +++ b/v4.2.1/extensions/get-started/anatomy/index.html @@ -0,0 +1,1111 @@ + + + + + + + + + + + + + + + + + + + + + + Extension Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Anatomy#

    +

    In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood.

    +

    The Hello World sample extension does three things:

    +
      +
    • Implements onActivate() and outputs a message to the console.
    • +
    • Implements onDectivate() and outputs a message to the console.
    • +
    • Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard.
    • +
    +

    Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.

    +

    Extension File Structure#

    +
    .
    +├── .gitignore          // Ignore build output and node_modules
    +├── Makefile            // Config for build tasks that compiles the extension
    +├── README.md           // Readable description of your extension's functionality
    +├── src
    +│   └── page.tsx         // Extension's additional source code
    +├── main.ts              // Source code for extension's main entrypoint
    +├── package.json         // Extension manifest and dependencies
    +├── renderer.tsx         // Source code for extension's renderer entrypoint
    +├── tsconfig.json        // TypeScript configuration
    +├── webpack.config.js    // Webpack configuration
    +
    +

    The extension directory contains the extension's entry files and a few configuration files. Three files: package.json, main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.

    +

    Extension Manifest#

    +

    Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes. Some of the most-important fields include:

    +
      +
    • name and publisher: Lens uses @<publisher>/<name> as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample. Lens uses this ID to uniquely identify your extension.
    • +
    • main: the extension's entry point run in main process.
    • +
    • renderer: the extension's entry point run in renderer process.
    • +
    • engines.lens: the minimum version of Lens API that the extension depends upon.
    • +
    +
    {
    +  "name": "helloworld-sample",
    +  "publisher": "lens-samples",
    +  "version": "0.0.1",
    +  "description": "Lens helloworld-sample",
    +  "license": "MIT",
    +  "homepage": "https://github.com/lensapp/lens-extension-samples",
    +  "engines": {
    +    "lens": "^4.0.0"
    +  },
    +  "main": "dist/main.js",
    +  "renderer": "dist/renderer.js",
    +  "scripts": {
    +    "build": "webpack --config webpack.config.js",
    +    "dev": "npm run build --watch"
    +  },
    +  "dependencies": {
    +    "react-open-doodles": "^1.0.5"
    +  },
    +  "devDependencies": {
    +    "@k8slens/extensions": "^4.0.0-alpha.2",
    +    "ts-loader": "^8.0.4",
    +    "typescript": "^4.0.3",
    +    "@types/react": "^16.9.35",
    +    "@types/node": "^12.0.0",
    +    "webpack": "^4.44.2",
    +    "webpack-cli": "^3.3.11"
    +  }
    +}
    +
    +

    Extension Entry Files#

    +

    Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.

    +

    Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

    +

    The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the "Hello World" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExampleIcon, ExamplePage } from "./page"
    +import React from "react"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterPages = [
    +    {
    +      id: "extension-example",
    +      components: {
    +        Page: () => <ExamplePage extension={this}/>,
    +      }
    +    }
    +  ]
    +}
    +
    +

    The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/get-started/overview/index.html b/v4.2.1/extensions/get-started/overview/index.html new file mode 100644 index 0000000000..c51fbb1178 --- /dev/null +++ b/v4.2.1/extensions/get-started/overview/index.html @@ -0,0 +1,1018 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Development Overview#

    +

    This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.

    +

    Required:#

    +
      +
    • Node.js
    • +
    • Git
    • +
    • Some sort of text editor – we recommend VSCode
    • +
    • We use Webpack for compilation. All extension need to be at least compatable with a webpack system.
    • +
    + +

    All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.

    +

    Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.

    +

    Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

    +

    See Your First Extension to get started.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/get-started/wrapping-up/index.html b/v4.2.1/extensions/get-started/wrapping-up/index.html new file mode 100644 index 0000000000..0ba90b1451 --- /dev/null +++ b/v4.2.1/extensions/get-started/wrapping-up/index.html @@ -0,0 +1,1030 @@ + + + + + + + + + + + + + + + + + + + + + + Wrapping Up - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Wrapping Up#

    +

    In Your First Extension, you learned how to create and run an extension. In Extension Anatomy, you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.

    +

    Extension Capabilities#

    +

    In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.

    +

    Guides and Samples#

    +

    Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.

    +

    Testing and Publishing#

    +

    In this section, you can learn:

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/get-started/your-first-extension/index.html b/v4.2.1/extensions/get-started/your-first-extension/index.html new file mode 100644 index 0000000000..adc1fe6b4a --- /dev/null +++ b/v4.2.1/extensions/get-started/your-first-extension/index.html @@ -0,0 +1,1141 @@ + + + + + + + + + + + + + + + + + + + + + + Your First Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Your First Extension#

    +

    We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here.

    +

    If you want to setup the project manually, please continue reading.

    +

    First Extension#

    +

    In this topic, you'll learn the basics of building extensions by creating an extension that adds a "Hello World" page to a cluster menu.

    +

    Install the Extension#

    +

    To install the extension, clone the Lens Extension samples repository to your local machine:

    +
    git clone https://github.com/lensapp/lens-extension-samples.git
    +
    +

    Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample.

    +

    Linux & macOS#

    +
    mkdir -p ~/.k8slens/extensions
    +cd ~/.k8slens/extensions
    +ln -s lens-extension-samples/helloworld-sample helloworld-sample
    +
    +

    Windows#

    +

    Create the directory that Lens will monitor for user-installed extensions:

    +
    mkdir C:\Users\<user>\.k8slens\extensions -force
    +cd C:\Users\<user>\.k8slens\extensions
    +
    +

    If you have administrator rights, you can create symlink to the sample extension – in this case helloworld-sample:

    +
    cmd /c mklink /D helloworld-sample lens-extension-samples\helloworld-sample
    +
    +

    Without administrator rights, you need to copy the extensions sample directory into C:\Users\<user>\.k8slens\extensions:

    +
    Copy-Item 'lens-extension-samples\helloworld-sample' 'C:\Users\<user>\.k8slens\extensions\helloworld-sample'
    +
    +

    Build the Extension#

    +

    To build the extension you can use make or run the npm commands manually:

    +
    cd <lens-extension-samples directory>/helloworld-sample
    +make build
    +
    +

    To run the npm commands, enter:

    +
    cd <lens-extension-samples directory>/helloworld-sample
    +npm install
    +npm run build
    +
    +

    Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:

    +
    cd <lens-extension-samples directory>/helloworld-sample
    +npm run dev
    +
    +

    You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.

    +

    With Lens running, either connect to an existing cluster or create a new one. You will see the "Hello World" page in the left-side cluster menu.

    +

    Develop the Extension#

    +

    Finally, you'll make a change to the message that our Hello World sample extension displays:

    +
      +
    1. Navigate to <lens-extension-samples directory>/helloworld-sample.
    2. +
    3. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
    4. +
    5. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
    6. +
    7. Reload the Lens window.
    8. +
    9. Click on the Hello World page.
    10. +
    11. The updated message will appear.
    12. +
    +

    Next Steps#

    +

    In the next topic, we'll take a closer look at the source code of our Hello World sample.

    +

    You can find the source code for this tutorial at: lensapp/lens-extension-samples. Extension Guides contains additional samples.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/anatomy/index.html b/v4.2.1/extensions/guides/anatomy/index.html new file mode 100644 index 0000000000..abf2cfe280 --- /dev/null +++ b/v4.2.1/extensions/guides/anatomy/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Anatomy

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/components/index.html b/v4.2.1/extensions/guides/components/index.html new file mode 100644 index 0000000000..7141453e83 --- /dev/null +++ b/v4.2.1/extensions/guides/components/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Components - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Components

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/generator/index.html b/v4.2.1/extensions/guides/generator/index.html new file mode 100644 index 0000000000..7e19528865 --- /dev/null +++ b/v4.2.1/extensions/guides/generator/index.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + + + + + + + + + Generator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Lens Extension Generator#

    +

    The Lens Extension Generator creates a directory with the necessary files for developing an extension.

    +

    Installing and Getting Started with the Generator#

    +

    To begin, install Yeoman and the Lens Extension Generator with the following command:

    +
    npm install -g yo generator-lens-ext
    +
    +

    Run the generator by entering the following command: yo lens-ext.

    +

    Answer the following questions:

    +
    # ? What type of extension do you want to create? New Extension (TypeScript)
    +# ? What's the name of your extension? my-first-lens-ext
    +# ? What's the description of your extension? My hello world extension
    +# ? What's your extension's publisher name? @my-org/my-first-lens-ext
    +# ? Initialize a git repository? Yes
    +# ? Install dependencies after initialization? Yes
    +# ? Which package manager to use? yarn
    +# ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\<user>\.k8slens\extensions (windows)? Yes
    +
    +

    Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering:

    +
    cd my-first-lens-ext
    +npm start # start the webpack server in watch mode
    +
    +

    Open Lens and you will see a Hello World item in the left-side menu under Custom Resources:

    +

    Hello World

    +

    Developing the Extension#

    +

    Next, you'll try changing the way the new menu item appears in the UI. You'll change it from "Hello World" to "Hello Lens".

    +

    Open my-first-lens-ext/renderer.tsx and change the value of title from "Hello World" to "Hello Lens":

    +
    clusterPageMenus = [
    +    {
    +        target: { pageId: "hello" },
    +        title: "Hello Lens",
    +        components: {
    +            Icon: ExampleIcon,
    +        }
    +    }
    +]
    +
    +

    Reload Lens and you will see that the menu item text has changed to "Hello Lens." To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.

    +

    Hello World

    +

    Debugging the Extension#

    +

    To debug your extension, please see our instructions on Testing Extensions.

    +

    Next Steps#

    +

    To dive deeper, consider looking at Common Capabilities, Styling, or Extension Anatomy.

    +

    If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue. You can find the Lens contribution guidelines here.

    +

    The Generator source code is hosted at Github.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/images/certificates-crd-list.png b/v4.2.1/extensions/guides/images/certificates-crd-list.png new file mode 100644 index 0000000000..19c9558f71 Binary files /dev/null and b/v4.2.1/extensions/guides/images/certificates-crd-list.png differ diff --git a/v4.2.1/extensions/guides/images/clusterpagemenus.png b/v4.2.1/extensions/guides/images/clusterpagemenus.png new file mode 100644 index 0000000000..3ed1c79e5b Binary files /dev/null and b/v4.2.1/extensions/guides/images/clusterpagemenus.png differ diff --git a/v4.2.1/extensions/guides/images/globalpagemenus.png b/v4.2.1/extensions/guides/images/globalpagemenus.png new file mode 100644 index 0000000000..e986cc32e9 Binary files /dev/null and b/v4.2.1/extensions/guides/images/globalpagemenus.png differ diff --git a/v4.2.1/extensions/guides/images/hello-lens.png b/v4.2.1/extensions/guides/images/hello-lens.png new file mode 100644 index 0000000000..5e2c0ac0a5 Binary files /dev/null and b/v4.2.1/extensions/guides/images/hello-lens.png differ diff --git a/v4.2.1/extensions/guides/images/hello-world.png b/v4.2.1/extensions/guides/images/hello-world.png new file mode 100644 index 0000000000..1a4a9c73a9 Binary files /dev/null and b/v4.2.1/extensions/guides/images/hello-world.png differ diff --git a/v4.2.1/extensions/guides/images/kubeobjectdetailitem.png b/v4.2.1/extensions/guides/images/kubeobjectdetailitem.png new file mode 100644 index 0000000000..e2d68f0c3b Binary files /dev/null and b/v4.2.1/extensions/guides/images/kubeobjectdetailitem.png differ diff --git a/v4.2.1/extensions/guides/images/kubeobjectdetailitemwithpods.png b/v4.2.1/extensions/guides/images/kubeobjectdetailitemwithpods.png new file mode 100644 index 0000000000..9a91f230f3 Binary files /dev/null and b/v4.2.1/extensions/guides/images/kubeobjectdetailitemwithpods.png differ diff --git a/v4.2.1/extensions/guides/images/kubeobjectmenuitem.png b/v4.2.1/extensions/guides/images/kubeobjectmenuitem.png new file mode 100644 index 0000000000..f9f91675de Binary files /dev/null and b/v4.2.1/extensions/guides/images/kubeobjectmenuitem.png differ diff --git a/v4.2.1/extensions/guides/images/kubeobjectmenuitemdetail.png b/v4.2.1/extensions/guides/images/kubeobjectmenuitemdetail.png new file mode 100644 index 0000000000..ab5f9ac0f0 Binary files /dev/null and b/v4.2.1/extensions/guides/images/kubeobjectmenuitemdetail.png differ diff --git a/v4.2.1/extensions/guides/images/routing-diag.png b/v4.2.1/extensions/guides/images/routing-diag.png new file mode 100644 index 0000000000..9185ce94d8 Binary files /dev/null and b/v4.2.1/extensions/guides/images/routing-diag.png differ diff --git a/v4.2.1/extensions/guides/index.html b/v4.2.1/extensions/guides/index.html new file mode 100644 index 0000000000..4cd7e5437b --- /dev/null +++ b/v4.2.1/extensions/guides/index.html @@ -0,0 +1,1092 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Guides#

    +

    This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension.

    +

    Each guide or code sample includes the following:

    +
      +
    • Clearly commented source code.
    • +
    • Instructions for running the sample extension.
    • +
    • An image showing the sample extension's appearance and usage.
    • +
    • A listing of the Extension API being used.
    • +
    • An explanation of the concepts relevant to the Extension.
    • +
    +

    Guides#

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    GuideAPIs
    Generate new extension project
    Main process extensionLensMainExtension
    Renderer process extensionLensRendererExtension
    Stores
    Components
    KubeObjectListLayout
    Working with mobx
    Protocol Handlers
    +

    Samples#

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SampleAPIs
    hello-worldLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    minikubeLensMainExtension
    Store.clusterStore
    Store.workspaceStore
    styling-css-modules-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    styling-emotion-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    styling-sass-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    custom-resource-pageLensRendererExtension
    K8sApi.KubeApi
    K8sApi.KubeObjectStore
    Component.KubeObjectListLayout
    Component.KubeObjectDetailsProps
    Component.IconProps
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/kube-object-list-layout/index.html b/v4.2.1/extensions/guides/kube-object-list-layout/index.html new file mode 100644 index 0000000000..8c9920025b --- /dev/null +++ b/v4.2.1/extensions/guides/kube-object-list-layout/index.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + + + + + + + + + + + KubeObjectListLayout Sample - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    KubeObjectListLayout Sample#

    +

    In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here.

    +

    +

    Next, we will go the implementation through in steps. To achieve our goal, we need to:

    +
      +
    1. Register ClustePage and ClusterPageMenu objects
    2. +
    3. List Certificate Objects on the Cluster Page
    4. +
    5. Customize Details Panel
    6. +
    +

    Register clusterPage and clusterPageMenu Objects#

    +

    First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

    +
    export default class CrdSampleExtension extends LensRendererExtension {
    +}
    +
    +

    To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with "Certificates" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

    +
    export function CertificateIcon(props: Component.IconProps) {
    +  return <Component.Icon {...props} material="security" tooltip="Certificates"/>
    +}
    +
    +export default class CrdSampleExtension extends LensRendererExtension {
    +
    +  clusterPageMenus = [
    +    {
    +      target: { pageId: "certificates" },
    +      title: "Certificates",
    +      components: {
    +        Icon: CertificateIcon,
    +      }
    +    },
    +  ]
    +}
    +
    +

    Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

    +
    export default class CrdSampleExtension extends LensRendererExtension {
    +  ...
    +
    +  clusterPages = [{
    +    id: "certificates",
    +    components: {
    +      Page: () => <CertificatePage extension={this} />,
    +      MenuIcon: CertificateIcon,
    +    }
    +  }]
    +}
    +
    +

    List Certificate Objects on the Cluster Page#

    +

    In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.

    +

    Get CRD objects#

    +

    In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject, CertificatesApiderived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore.

    +

    Certificate class defines properties found in the CRD object:

    +
    export class Certificate extends K8sApi.KubeObject {
    +  static kind = "Certificate"
    +  static namespaced = true
    +  static apiBase = "/apis/cert-manager.io/v1alpha2/certificates"
    +
    +  kind: string
    +  apiVersion: string
    +  metadata: {
    +    name: string;
    +    namespace: string;
    +    selfLink: string;
    +    uid: string;
    +    resourceVersion: string;
    +    creationTimestamp: string;
    +    labels: {
    +      [key: string]: string;
    +    };
    +    annotations: {
    +      [key: string]: string;
    +    };
    +  }
    +  spec: {
    +    dnsNames: string[];
    +    issuerRef: {
    +      group: string;
    +      kind: string;
    +      name: string;
    +    }
    +    secretName: string
    +  }
    +  status: {
    +    conditions: {
    +      lastTransitionTime: string;
    +      message: string;
    +      reason: string;
    +      status: string;
    +      type?: string;
    +    }[];
    +  }
    +}
    +
    +

    With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

    +
    export class CertificatesApi extends K8sApi.KubeApi<Certificate> {
    +}
    +export const certificatesApi = new CertificatesApi({
    +  objectConstructor: Certificate
    +});
    +
    +

    CertificateStore defines storage for Certificate objects

    +
    export class CertificatesStore extends K8sApi.KubeObjectStore<Certificate> {
    +  api = certificatesApi
    +}
    +
    +export const certificatesStore = new CertificatesStore();
    +
    +

    And, finally, we register this store to Lens's API manager.

    +
    K8sApi.apiManager.registerStore(certificatesStore);
    +
    +

    Create CertificatePage component#

    +

    Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.

    +

    First we define CertificatePage class that extends React.Component.

    +
    import { Component, LensRendererExtension } from "@k8slens/extensions";
    +import React from "react";
    +import { certificatesStore } from "../certificate-store";
    +import { Certificate } from "../certificate"
    +
    +export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
    +
    +}
    +
    +

    Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:

    +
    enum sortBy {
    +  name = "name",
    +  namespace = "namespace",
    +  issuer = "issuer"
    +}
    +
    +export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
    +  // ...
    +
    +  render() {
    +    return (
    +      <Component.TabLayout>
    +        <Component.KubeObjectListLayout
    +          className="Certicates" store={certificatesStore}
    +          sortingCallbacks={{
    +            [sortBy.name]: (certificate: Certificate) => certificate.getName(),
    +            [sortBy.namespace]: (certificate: Certificate) => certificate.metadata.namespace,
    +            [sortBy.issuer]: (certificate: Certificate) => certificate.spec.issuerRef.name
    +          }}
    +          searchFilters={[
    +            (certificate: Certificate) => certificate.getSearchFields()
    +          ]}
    +          renderHeaderTitle="Certificates"
    +          renderTableHeader={[
    +            { title: "Name", className: "name", sortBy: sortBy.name },
    +            { title: "Namespace", className: "namespace", sortBy: sortBy.namespace },
    +            { title: "Issuer", className: "issuer", sortBy: sortBy.namespace },
    +          ]}
    +          renderTableContents={(certificate: Certificate) => [
    +            certificate.getName(),
    +            certificate.metadata.namespace,
    +            certificate.spec.issuerRef.name
    +          ]}
    +        />
    +      </Component.TabLayout>
    +    )
    +  }
    +}
    +
    +

    Customize Details panel#

    +

    We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.

    +

    First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:

    +
    export default class CrdSampleExtension extends LensRendererExtension {
    +  //...
    +
    +  kubeObjectDetailItems = [{
    +    kind: Certificate.kind,
    +    apiVersions: ["cert-manager.io/v1alpha2"],
    +    components: {
    +      Details: (props: CertificateDetailsProps) => <CertificateDetails {...props} />
    +    }
    +  }]
    +}
    +
    +

    Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

    +
    import { Component, K8sApi } from "@k8slens/extensions";
    +import React from "react";
    +import { Certificate } from "../certificate";
    +
    +export interface CertificateDetailsProps extends Component.KubeObjectDetailsProps<Certificate>{
    +}
    +
    +export class CertificateDetails extends React.Component<CertificateDetailsProps> {
    +
    +  render() {
    +    const { object: certificate } = this.props;
    +    if (!certificate) return null;
    +    return (
    +      <div className="Certificate">
    +        <Component.DrawerItem name="Created">
    +          {certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })
    +        </Component.DrawerItem>
    +        <Component.DrawerItem name="DNS Names">
    +          {certificate.spec.dnsNames.join(",")}
    +        </Component.DrawerItem>
    +        <Component.DrawerItem name="Secret">
    +          {certificate.spec.secretName}
    +        </Component.DrawerItem>
    +        <Component.DrawerItem name="Status" className="status" labelsOnly>
    +          {certificate.status.conditions.map((condition, index) => {
    +            const { type, reason, message, status } = condition;
    +            const kind = type || reason;
    +            if (!kind) return null;
    +            return (
    +              <Component.Badge
    +                key={kind + index} label={kind}
    +                className={"success "+kind.toLowerCase()}
    +                tooltip={message}
    +              />
    +            );
    +          })}
    +        </Component.DrawerItem>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Summary#

    +

    Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/main-extension/index.html b/v4.2.1/extensions/guides/main-extension/index.html new file mode 100644 index 0000000000..613432eceb --- /dev/null +++ b/v4.2.1/extensions/guides/main-extension/index.html @@ -0,0 +1,1103 @@ + + + + + + + + + + + + + + + + + + + + + + Main Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Main Extension#

    +

    The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.

    +

    LensMainExtension Class#

    +

    onActivate() and onDeactivate() Methods#

    +

    To create a main extension simply extend the LensMainExtension class:

    +
    import { LensMainExtension } from "@k8slens/extensions";
    +
    +export default class ExampleExtensionMain extends LensMainExtension {
    +  onActivate() {
    +    console.log('custom main process extension code started');
    +  }
    +
    +  onDeactivate() {
    +    console.log('custom main process extension de-activated');
    +  }
    +}
    +
    +

    Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

    +

    Disable extensions from the Lens Extensions page:

    +
      +
    1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
    2. +
    3. Click Disable on the extension you want to disable.
    4. +
    +

    The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.

    +

    The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens.

    +
    import { LensMainExtension, Store } from "@k8slens/extensions";
    +
    +const clusterStore = Store.clusterStore
    +
    +export default class ActiveClusterExtensionMain extends LensMainExtension {
    +
    +  timer: NodeJS.Timeout
    +
    +  onActivate() {
    +    console.log("Cluster logger activated");
    +    this.timer = setInterval(() => {
    +      if (!clusterStore.active) {
    +        console.log("No active cluster");
    +        return;
    +      }
    +      console.log("active cluster is", clusterStore.active.contextName)
    +    }, 5000)
    +  }
    +
    +  onDeactivate() {
    +      clearInterval(this.timer)
    +      console.log("Cluster logger deactivated");
    +  }
    +}
    +
    +

    For more details on accessing Lens state data, please see the Stores guide.

    +

    appMenus#

    +

    The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu.

    +
    import { LensMainExtension } from "@k8slens/extensions";
    +
    +export default class SamplePageMainExtension extends LensMainExtension {
    +  appMenus = [
    +    {
    +      parentId: "help",
    +      label: "Sample",
    +      click() {
    +        console.log("Sample clicked");
    +      }
    +    }
    +  ]
    +}
    +
    +

    appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows:

    +
      +
    • parentId is the name of the menu where your new menu item will be listed. Valid values include: "file", "edit", "view", and "help". "lens" is valid on Mac only.
    • +
    • label is the name of your menu item.
    • +
    • click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.
    • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/protocol-handlers/index.html b/v4.2.1/extensions/guides/protocol-handlers/index.html new file mode 100644 index 0000000000..1fc5724fe2 --- /dev/null +++ b/v4.2.1/extensions/guides/protocol-handlers/index.html @@ -0,0 +1,989 @@ + + + + + + + + + + + + + + + + + + + + + + Lens Protocol Handlers - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Lens Protocol Handlers#

    +

    Lens has a file association with the lens:// protocol. +This means that Lens can be opened by external programs by providing a link that has lens as its protocol. +Lens provides a routing mechanism that extensions can use to register custom handlers.

    +

    Registering A Protocol Handler#

    +

    The field protocolHandlers exists both on LensMainExtension and on LensRendererExtension. +This field will be iterated through every time a lens:// request gets sent to the application. +The pathSchema argument must comply with the path-to-regexp package's compileToRegex function.

    +

    Once you have registered a handler it will be called when a user opens a link on their computer. +Handlers will be run in both main and renderer in parallel with no synchronization between the two processes. +Furthermore, both main and renderer are routed separately. +In other words, which handler is selected in either process is independent from the list of possible handlers in the other.

    +

    Example of registering a handler:

    +
    import { LensMainExtension, Interface } from "@k8slens/extensions";
    +
    +function rootHandler(params: Iterface.ProtocolRouteParams) {
    +  console.log("routed to ExampleExtension", params);
    +}
    +
    +export default class ExampleExtensionMain extends LensMainExtension {
    +  protocolHandlers = [
    +    pathSchema: "/",
    +    handler: rootHandler,
    +  ]
    +}
    +
    +

    For testing the routing of URIs the open (on macOS) or xdg-open (on most linux) CLI utilities can be used. +For the above handler, the following URI would be always routed to it:

    +
    open lens://extension/example-extension/
    +
    +

    Deregistering A Protocol Handler#

    +

    All that is needed to deregister a handler is to remove it from the array of handlers.

    +

    Routing Algorithm#

    +

    The routing mechanism for extensions is quite straight forward. +For example consider an extension example-extension which is published by the @mirantis org. +If it were to register a handler with "/display/:type" as its corresponding link then we would match the following URI like this:

    +

    Lens Protocol Link Resolution

    +

    Once matched, the handler would be called with the following argument (note both "search" and "pathname" will always be defined):

    +
    {
    +  "search": {
    +    "text": "Hello"
    +  },
    +  "pathname": {
    +    "type": "notification"
    +  }
    +}
    +
    +

    As the diagram above shows, the search (or query) params are not considered as part of the handler resolution. +If the URI had instead been lens://extension/@mirantis/example-extension/display/notification/green then a third (and optional) field will have the rest of the path. +The tail field would be filled with "/green". +If multiple pathSchema's match a given URI then the most specific handler will be called.

    +

    For example consider the following pathSchema's:

    +
      +
    1. "/"
    2. +
    3. "/display"
    4. +
    5. "/display/:type"
    6. +
    7. "/show/:id"
    8. +
    +

    The URI sub-path "/display" would be routed to #2 since it is an exact match. +On the other hand, the subpath "/display/notification" would be routed to #3.

    +

    The URI is routed to the most specific matching pathSchema. +This way the "/" (root) pathSchema acts as a sort of catch all or default route if no other route matches.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/renderer-extension/index.html b/v4.2.1/extensions/guides/renderer-extension/index.html new file mode 100644 index 0000000000..dbac63aa4c --- /dev/null +++ b/v4.2.1/extensions/guides/renderer-extension/index.html @@ -0,0 +1,1892 @@ + + + + + + + + + + + + + + + + + + + + + + Renderer Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Renderer Extension#

    +

    The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, and run custom code in Lens's renderer process.

    +

    The custom Lens UI elements that you can add include:

    + +

    All UI elements are based on React components.

    +

    LensRendererExtension Class#

    +

    onActivate() and onDeactivate() Methods#

    +

    To create a renderer extension, extend the LensRendererExtension class:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +
    +export default class ExampleExtensionMain extends LensRendererExtension {
    +  onActivate() {
    +    console.log('custom renderer process extension code started');
    +  }
    +
    +  onDeactivate() {
    +    console.log('custom renderer process extension de-activated');
    +  }
    +}
    +
    +

    Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

    +
    +

    Info

    +

    Disable extensions from the Lens Extensions page:

    +
      +
    1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
    2. +
    3. Click Disable on the extension you want to disable.
    4. +
    +
    +

    The example above logs messages when the extension is enabled and disabled.

    +

    clusterPages#

    +

    Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with clusterStore.

    +

    Add a cluster page definition to a LensRendererExtension subclass with the following example:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExampleIcon, ExamplePage } from "./page"
    +import React from "react"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterPages = [
    +    {
    +      id: "hello",
    +      components: {
    +        Page: () => <ExamplePage extension={this}/>,
    +      }
    +    }
    +  ];
    +}
    +
    +

    clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows:

    +
      +
    • id is a string that identifies the page.
    • +
    • components matches the PageComponents interface for which there is one field, Page.
    • +
    • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.
    • +
    +

    ExamplePage in the example above can be defined in page.tsx:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import React from "react"
    +
    +export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
    +  render() {
    +    return (
    +      <div>
    +        <p>Hello world!</p>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Note that the ExamplePage class defines the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data.

    +

    The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus, covered in the next section, to add cluster pages to the Lens UI.

    +

    clusterPageMenus#

    +

    clusterPageMenus allows you to add cluster page menu items to the secondary left nav.

    +

    By expanding on the above example, you can add a cluster page menu item to the ExampleExtension definition:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExampleIcon, ExamplePage } from "./page"
    +import React from "react"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterPages = [
    +    {
    +      id: "hello",
    +      components: {
    +        Page: () => <ExamplePage extension={this}/>,
    +      }
    +    }
    +  ];
    +
    +  clusterPageMenus = [
    +    {
    +      target: { pageId: "hello" },
    +      title: "Hello World",
    +      components: {
    +        Icon: ExampleIcon,
    +      }
    +    },
    +  ];
    +}
    +
    +

    clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows:

    +
      +
    • target links to the relevant cluster page using pageId.
    • +
    • pageId takes the value of the relevant cluster page's id property.
    • +
    • title sets the name of the cluster page menu item that will appear in the left side menu.
    • +
    • components is used to set an icon that appears to the left of the title text in the left side menu.
    • +
    +

    The above example creates a menu item that reads Hello World. When users click Hello World, the cluster dashboard will show the contents of Example Page.

    +

    This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx, as follows:

    +
    import { LensRendererExtension, Component } from "@k8slens/extensions";
    +import React from "react"
    +
    +export function ExampleIcon(props: Component.IconProps) {
    +  return <Component.Icon {...props} material="pages" tooltip={"Hi!"}/>
    +}
    +
    +export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
    +  render() {
    +    return (
    +      <div>
    +        <p>Hello world!</p>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. The properties that Component.Icon uses are defined as follows:

    +
      +
    • material takes the name of the icon you want to use.
    • +
    • tooltip sets the text you want to appear when a user hovers over the icon.
    • +
    +

    clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExampleIcon, ExamplePage } from "./page"
    +import React from "react"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  clusterPages = [
    +    {
    +      id: "hello",
    +      components: {
    +        Page: () => <ExamplePage extension={this}/>,
    +      }
    +    },
    +    {
    +      id: "bonjour",
    +      components: {
    +        Page: () => <ExemplePage extension={this}/>,
    +      }
    +    }
    +  ];
    +
    +  clusterPageMenus = [
    +    {
    +      id: "example",
    +      title: "Greetings",
    +      components: {
    +        Icon: ExampleIcon,
    +      }
    +    },
    +    {
    +      parentId: "example",
    +      target: { pageId: "hello" },
    +      title: "Hello World",
    +      components: {
    +        Icon: ExampleIcon,
    +      }
    +    },
    +    {
    +      parentId: "example",
    +      target: { pageId: "bonjour" },
    +      title: "Bonjour le monde",
    +      components: {
    +        Icon: ExempleIcon,
    +      }
    +    }
    +  ];
    +}
    +
    +

    The above defines two cluster pages and three cluster page menu objects. +The cluster page definitions are straightforward. +The three cluster page menu objects include one parent menu item and two sub menu items. +The first cluster page menu object defines the parent of a foldout submenu. +Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. +Also note that the target field is not specified (it is ignored if the id field is specified). +This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. +Initially the submenu is hidden. +Activating this menu item toggles on and off the appearance of the submenu below it. +The remaining two cluster page menu objects define the contents of the submenu. +A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, "example" in this case.

    +

    This is what the example will look like, including how the menu item will appear in the secondary left nav:

    +

    globalPages#

    +

    Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters, including customized data and functionality unique to your extension.

    +

    Typically, you would use a global page menu located in the left nav to trigger a global page. You can also trigger a global page with a custom app menu selection from a Main Extension or a custom status bar item. Unlike cluster pages, users can trigger global pages even when there is no active cluster.

    +

    The following example defines a LensRendererExtension subclass with a single global page definition:

    +
    import { LensRendererExtension } from '@k8slens/extensions';
    +import { HelpPage } from './page';
    +import React from 'react';
    +
    +export default class HelpExtension extends LensRendererExtension {
    +  globalPages = [
    +    {
    +      id: "help",
    +      components: {
    +        Page: () => <HelpPage extension={this}/>,
    +      }
    +    }
    +  ];
    +}
    +
    +

    globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows:

    +
      +
    • id is a string that identifies the page.
    • +
    • components matches the PageComponents interface for which there is one field, Page.
    • +
    • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.
    • +
    +

    HelpPage in the example above can be defined in page.tsx:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import React from "react"
    +
    +export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
    +  render() {
    +    return (
    +      <div>
    +        <p>Help yourself</p>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Note that the HelpPage class defines the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data.

    +

    This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages can be made available in the following ways:

    +
      +
    • To add global pages to the top menu bar, see appMenus in the Main Extension guide.
    • +
    • To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems.
    • +
    • To add global pages to the left side menu, see globalPageMenus.
    • +
    +

    globalPageMenus#

    +

    globalPageMenus allows you to add global page menu items to the left nav.

    +

    By expanding on the above example, you can add a global page menu item to the HelpExtension definition:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { HelpIcon, HelpPage } from "./page"
    +import React from "react"
    +
    +export default class HelpExtension extends LensRendererExtension {
    +  globalPages = [
    +    {
    +      id: "help",
    +      components: {
    +        Page: () => <HelpPage extension={this}/>,
    +      }
    +    }
    +  ];
    +
    +  globalPageMenus = [
    +    {
    +      target: { pageId: "help" },
    +      title: "Help",
    +      components: {
    +        Icon: HelpIcon,
    +      }
    +    },
    +  ];
    +}
    +
    +

    globalPageMenus is an array of objects that satisfy the PageMenuRegistration interface. This element defines how the global page menu item will appear and what it will do when you click it. The properties of the globalPageMenus array objects are defined as follows:

    +
      +
    • target links to the relevant global page using pageId.
    • +
    • pageId takes the value of the relevant global page's id property.
    • +
    • title sets the name of the global page menu item that will display as a tooltip in the left nav.
    • +
    • components is used to set an icon that appears in the left nav.
    • +
    +

    The above example creates a "Help" icon menu item. When users click the icon, the Lens UI will display the contents of ExamplePage.

    +

    This example requires the definition of another React-based component, HelpIcon. Update page.tsx from the example above with the HelpIcon definition, as follows:

    +
    import { LensRendererExtension, Component } from "@k8slens/extensions";
    +import React from "react"
    +
    +export function HelpIcon(props: Component.IconProps) {
    +  return <Component.Icon {...props} material="help"/>
    +}
    +
    +export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
    +  render() {
    +    return (
    +      <div>
    +        <p>Help</p>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon, introduced in HelpIcon, which you can use to access any of the icons available at Material Design. The property that Component.Icon uses is defined as follows:

    +
      +
    • material takes the name of the icon you want to use.
    • +
    +

    This is what the example will look like, including how the menu item will appear in the left nav:

    +

    globalPageMenus

    +

    clusterFeatures#

    +

    Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. +They can be installed and uninstalled by the Lens user from the cluster Settings page.

    +
    +

    Info

    +

    To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings.

    +
    +

    The following example shows how to add a cluster feature as part of a LensRendererExtension:

    +
    import { LensRendererExtension } from "@k8slens/extensions"
    +import { ExampleFeature } from "./src/example-feature"
    +import React from "react"
    +
    +export default class ExampleFeatureExtension extends LensRendererExtension {
    +  clusterFeatures = [
    +    {
    +      title: "Example Feature",
    +      components: {
    +        Description: () => {
    +          return (
    +            <span>
    +                Enable an example feature.
    +            </span>
    +          )
    +        }
    +      },
    +      feature: new ExampleFeature()
    +    }
    +  ];
    +}
    +
    +

    The properties of the clusterFeatures array objects are defined as follows:

    +
      +
    • title and components.Description provide content that appears on the cluster settings page, in the Features section.
    • +
    • feature specifies an instance which extends the abstract class ClusterFeature.Feature, and specifically implements the following methods:
    • +
    +
      abstract install(cluster: Cluster): Promise<void>;
    +  abstract upgrade(cluster: Cluster): Promise<void>;
    +  abstract uninstall(cluster: Cluster): Promise<void>;
    +  abstract updateStatus(cluster: Cluster): Promise<ClusterFeatureStatus>;
    +
    +

    The four methods listed above are defined as follows:

    +
      +
    • +

      The install() method installs Kubernetes resources using the applyResources() method, or by directly accessing the Kubernetes API. +This method is typically called when a user indicates that they want to install the feature (i.e., by clicking Install for the feature in the cluster settings page).

      +
    • +
    • +

      The upgrade() method upgrades the Kubernetes resources already installed, if they are relevant to the feature. +This method is typically called when a user indicates that they want to upgrade the feature (i.e., by clicking Upgrade for the feature in the cluster settings page).

      +
    • +
    • +

      The uninstall() method uninstalls Kubernetes resources using the Kubernetes API. +This method is typically called when a user indicates that they want to uninstall the feature (i.e., by clicking Uninstall for the feature in the cluster settings page).

      +
    • +
    • +

      The updateStatus() method provides the current status information in the status field of the ClusterFeature.Feature parent class. +Lens periodically calls this method to determine details about the feature's current status. +The implementation of this method should uninstall Kubernetes resources using the Kubernetes api (K8sApi) +Consider using the following properties with updateStatus():

      +
        +
      • +

        status.currentVersion and status.latestVersion may be displayed by Lens in the feature's description.

        +
      • +
      • +

        status.installed should be set to true if the feature is installed, and false otherwise.

        +
      • +
      • +

        status.canUpgrade is set according to a rule meant to determine whether the feature can be upgraded. This rule can involve status.currentVersion and status.latestVersion, if desired.

        +
      • +
      +
    • +
    +

    The following shows a very simple implementation of a ClusterFeature:

    +
    import { ClusterFeature, Store, K8sApi } from "@k8slens/extensions";
    +import * as path from "path";
    +
    +export class ExampleFeature extends ClusterFeature.Feature {
    +
    +  async install(cluster: Store.Cluster): Promise<void> {
    +
    +    super.applyResources(cluster, path.join(__dirname, "../resources/"));
    +  }
    +
    +  async upgrade(cluster: Store.Cluster): Promise<void> {
    +    return this.install(cluster);
    +  }
    +
    +  async updateStatus(cluster: Store.Cluster): Promise<ClusterFeature.FeatureStatus> {
    +    try {
    +      const pod = K8sApi.forCluster(cluster, K8sApi.Pod);
    +      const examplePod = await pod.get({name: "example-pod", namespace: "default"});
    +      if (examplePod?.kind) {
    +        this.status.installed = true;
    +        this.status.currentVersion = examplePod.spec.containers[0].image.split(":")[1];
    +        this.status.canUpgrade = true;  // a real implementation would perform a check here that is relevant to the specific feature
    +      } else {
    +        this.status.installed = false;
    +        this.status.canUpgrade = false;
    +      }
    +    } catch(e) {
    +      if (e?.error?.code === 404) {
    +        this.status.installed = false;
    +        this.status.canUpgrade = false;
    +      }
    +    }
    +
    +    return this.status;
    +  }
    +
    +  async uninstall(cluster: Store.Cluster): Promise<void> {
    +    const podApi = K8sApi.forCluster(cluster, K8sApi.Pod);
    +    await podApi.delete({name: "example-pod", namespace: "default"});
    +  }
    +}
    +
    +

    This example implements the install() method by invoking the helper applyResources() method. +applyResources() tries to apply all resources read from all files found in the folder path provided. +In this case the folder path is the ../resources subfolder relative to the current source code's folder. +The file ../resources/example-pod.yml could contain:

    +
    apiVersion: v1
    +kind: Pod
    +metadata:
    +  name: example-pod
    +spec:
    +  containers:
    +  - name: example-pod
    +    image: nginx
    +
    +

    The example above implements the four methods as follows:

    +
      +
    • +

      It implements upgrade() by invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps.

      +
    • +
    • +

      It implements uninstall() by utilizing the Kubernetes API which Lens provides to delete the example-pod applied by the install() method.

      +
    • +
    • +

      It implements updateStatus() by using the Kubernetes API which Lens provides to determine whether the example-pod is installed, what version is associated with it, and whether it can be upgraded. The implementation determines what the status is for a specific cluster feature.

      +
    • +
    +

    appPreferences#

    +

    The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.

    +

    The following example demonstrates adding a custom preference:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
    +import { observable } from "mobx";
    +import React from "react";
    +
    +export default class ExampleRendererExtension extends LensRendererExtension {
    +
    +  @observable preference = { enabled: false };
    +
    +  appPreferences = [
    +    {
    +      title: "Example Preferences",
    +      components: {
    +        Input: () => <ExamplePreferenceInput preference={this.preference}/>,
    +        Hint: () => <ExamplePreferenceHint/>
    +      }
    +    }
    +  ];
    +}
    +
    +

    appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows:

    +
      +
    • title sets the heading text displayed on the Preferences page.
    • +
    • components specifies two React.Component objects that define the interface for the preference.
        +
      • Input specifies an interactive input element for the preference.
      • +
      • Hint provides descriptive information for the preference, shown below the Input element.
      • +
      +
    • +
    +
    +

    Note

    +

    Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension.

    +
    +

    ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. +ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput.

    +

    In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows:

    +
    import { Component } from "@k8slens/extensions";
    +import { observer } from "mobx-react";
    +import React from "react";
    +
    +export class ExamplePreferenceProps {
    +  preference: {
    +    enabled: boolean;
    +  }
    +}
    +
    +@observer
    +export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
    +
    +  render() {
    +    const { preference } = this.props;
    +    return (
    +      <Component.Checkbox
    +        label="I understand appPreferences"
    +        value={preference.enabled}
    +        onChange={v => { preference.enabled = v; }}
    +      />
    +    );
    +  }
    +}
    +
    +export class ExamplePreferenceHint extends React.Component {
    +  render() {
    +    return (
    +      <span>This is an example of an appPreference for extensions.</span>
    +    );
    +  }
    +}
    +
    +

    ExamplePreferenceInput implements a simple checkbox using Lens's Component.Checkbox using the following properties:

    +
      +
    • label sets the text that displays next to the checkbox.
    • +
    • value is initially set to preference.enabled.
    • +
    • onChange is a function that responds when the state of the checkbox changes.
    • +
    +

    ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange.

    +

    ExamplePreferenceHint is a simple text span.

    +

    The above example introduces the decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management. Without it, this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements. We recommend that extensions rely on it, as well. +Alternatively, you can use React's state management, though mobx is typically simpler to use.

    +

    Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore.

    +

    statusBarItems#

    +

    The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages.

    +

    The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It configures the status bar item to navigate to the global page upon activation (normally a mouse click):

    +
    import { LensRendererExtension } from '@k8slens/extensions';
    +import { HelpIcon, HelpPage } from "./page"
    +import React from 'react';
    +
    +export default class HelpExtension extends LensRendererExtension {
    +  globalPages = [
    +    {
    +      id: "help",
    +      components: {
    +        Page: () => <HelpPage extension={this}/>,
    +      }
    +    }
    +  ];
    +
    +  statusBarItems = [
    +    {
    +      components: {
    +        Item: (
    +          <div
    +            className="flex align-center gaps"
    +            onClick={() => this.navigate("help")}
    +          >
    +            <HelpIcon />
    +            My Status Bar Item
    +          </div>
    +        )
    +      },
    +    },
    +  ];
    +}
    +
    +

    The properties of the statusBarItems array objects are defined as follows:

    +
      +
    • Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide.
    • +
    • onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.
    • +
    +

    kubeObjectMenuItems#

    +

    An extension can add custom menu items (kubeObjectMenuItems) for specific Kubernetes resource kinds and apiVersions. +kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard:

    +

    List

    +

    They also appear on the title bar of the details page for specific resources:

    +

    Details

    +

    The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action:

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions";
    +import { NamespaceMenuItem } from "./src/namespace-menu-item"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  kubeObjectMenuItems = [
    +    {
    +      kind: "Namespace",
    +      apiVersions: ["v1"],
    +      components: {
    +        MenuItem: (props: Component.KubeObjectMenuProps<K8sApi.Namespace>) => <NamespaceMenuItem {...props} />
    +      }
    +    }
    +  ];
    +}
    +
    +

    kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows:

    +
      +
    • kind specifies the Kubernetes resource type the menu item will apply to.
    • +
    • apiVersion specifies the Kubernetes API version number to use with the resource type.
    • +
    • components defines the menu item's appearance and behavior.
    • +
    • MenuItem provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned.
    • +
    +

    NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:

    +
    import React from "react";
    +import { Component, K8sApi, Navigation} from "@k8slens/extensions";
    +
    +export function NamespaceMenuItem(props: Component.KubeObjectMenuProps<K8sApi.Namespace>) {
    +  const { object: namespace, toolbar } = props;
    +  if (!namespace) return null;
    +
    +  const namespaceName = namespace.getName();
    +
    +  const sendToTerminal = (command: string) => {
    +    Component.terminalStore.sendCommand(command, {
    +      enter: true,
    +      newTab: true,
    +    });
    +    Navigation.hideDetails();
    +  };
    +
    +  const getPods = () => {
    +    sendToTerminal(`kubectl get pods -n ${namespaceName}`);
    +  };
    +
    +  return (
    +    <Component.MenuItem onClick={getPods}>
    +    <Component.Icon material="speaker_group" interactive={toolbar} title="Get pods in terminal"/>
    +    <span className="title">Get Pods</span>
    +    </Component.MenuItem>
    +  );
    +}
    +
    +

    NamespaceMenuItem returns a Component.MenuItem which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace.

    +

    The name of the namespace is retrieved from props passed into NamespaceMenuItem(). namespace is the props.object, which is of type K8sApi.Namespace. K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName(). Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.

    +

    kubeObjectDetailItems#

    +

    An extension can add custom details (kubeObjectDetailItems) for specified Kubernetes resource kinds and apiVersions. +These custom details appear on the details page for a specific resource, such as a Namespace as shown here:

    +

    Details

    +

    The following example shows how to use kubeObjectDetailItems to add a tabulated list of pods to the Namespace resource details page:

    +
    import React from "react"
    +import { LensRendererExtension } from "@k8slens/extensions";
    +import { NamespaceDetailsItem } from "./src/namespace-details-item"
    +
    +export default class ExampleExtension extends LensRendererExtension {
    +  kubeObjectDetailItems = [
    +    {
    +      kind: "Namespace",
    +      apiVersions: ["v1"],
    +      priority: 10,
    +      components: {
    +        Details: (props: Component.KubeObjectDetailsProps<K8sApi.Namespace>) => <NamespaceDetailsItem {...props} />
    +      }
    +    }
    +  ];
    +}
    +
    +

    kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows:

    +
      +
    • kind specifies the Kubernetes resource type the detail item will apply to.
    • +
    • apiVersion specifies the Kubernetes API version number to use with the resource type.
    • +
    • components defines the detail item's appearance and behavior.
    • +
    • Details provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned.
    • +
    +

    NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:

    +
    import { Component, K8sApi } from "@k8slens/extensions";
    +import { PodsDetailsList } from "./pods-details-list";
    +import React from "react";
    +import { observable } from "mobx";
    +import { observer } from "mobx-react";
    +
    +@observer
    +export class NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>> {
    +
    +  @observable private pods: K8sApi.Pod[];
    +
    +  async componentDidMount() {
    +    this.pods = await K8sApi.podsApi.list({namespace: this.props.object.getName()});
    +  }
    +
    +  render() {
    +    return (
    +      <div>
    +        <Component.DrawerTitle title="Pods" />
    +        <PodsDetailsList pods={this.pods}/>
    +      </div>
    +    )
    +  }
    +}
    +
    +

    Since NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>>, it can access the current namespace object (type K8sApi.Namespace) through this.props.object. +You can query this object for many details about the current namespace. +In the example above, componentDidMount() gets the namespace's name using the K8sApi.Namespace getName() method. +Use the namespace's name to limit the list of pods only to those in the relevant namespace. +To get this list of pods, this example uses the Kubernetes pods API K8sApi.podsApi.list() method. +The K8sApi.podsApi is automatically configured for the active cluster.

    +

    Note that K8sApi.podsApi.list() is an asynchronous method. +Getting the pods list should occur prior to rendering the NamespaceDetailsItem. +It is a common technique in React development to await async calls in componentDidMount(). +However, componentDidMount() is called right after the first call to render(). +In order to effect a subsequent render() call, React must be made aware of a state change. +Like in the appPreferences guide, mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list updates. +This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.

    +

    Finally, the NamespaceDetailsItem renders using the render() method. +Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. +Multiple details in a drawer can be placed in <Component.DrawerItem> elements for further separation, if desired. +The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:

    +
    import React from "react";
    +import { Component, K8sApi } from "@k8slens/extensions";
    +
    +interface Props {
    +  pods: K8sApi.Pod[];
    +}
    +
    +export class PodsDetailsList extends React.Component<Props> {
    +
    +  getTableRow(index: number) {
    +      const {pods} = this.props;
    +      return (
    +          <Component.TableRow key={index} nowrap>
    +              <Component.TableCell className="podName">{pods[index].getName()}</Component.TableCell>
    +              <Component.TableCell className="podAge">{pods[index].getAge()}</Component.TableCell>
    +              <Component.TableCell className="podStatus">{pods[index].getStatus()}</Component.TableCell>
    +          </Component.TableRow>
    +      )
    +  }
    +
    +  render() {
    +      const {pods} = this.props
    +      if (!pods?.length) {
    +          return null;
    +      }
    +
    +      return (
    +          <div >
    +              <Component.Table>
    +                  <Component.TableHead>
    +                      <Component.TableCell className="podName">Name</Component.TableCell>
    +                      <Component.TableCell className="podAge">Age</Component.TableCell>
    +                      <Component.TableCell className="podStatus">Status</Component.TableCell>
    +                  </Component.TableHead>
    +                  {
    +                      pods.map((pod, index) => this.getTableRow(index))
    +                  }
    +              </Component.Table>
    +          </div>
    +      )
    +  }
    +}
    +
    +

    PodsDetailsList produces a simple table showing a list of the pods found in this namespace:

    +

    DetailsWithPods

    +

    Obtain the name, age, and status for each pod using the K8sApi.Pod methods. Construct the table using the Component.Table and related elements.

    +

    For each pod the name, age, and status are obtained using the K8sApi.Pod methods. +The table is constructed using the Component.Table and related elements. +See Component documentation for further details.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/stores/index.html b/v4.2.1/extensions/guides/stores/index.html new file mode 100644 index 0000000000..eba94325d6 --- /dev/null +++ b/v4.2.1/extensions/guides/stores/index.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + + + + + + Stores - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Stores#

    +

    Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including:

    +
      +
    • The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active.
    • +
    • The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace.
    • +
    • The ExtensionStore manages custom extension state data.
    • +
    +

    This guide focuses on the ExtensionStore.

    +

    ExtensionStore#

    +

    Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted.

    +

    The following example code creates a store for the appPreferences guide example:

    +
    import { Store } from "@k8slens/extensions";
    +import { observable, toJS } from "mobx";
    +
    +export type ExamplePreferencesModel = {
    +  enabled: boolean;
    +};
    +
    +export class ExamplePreferencesStore extends Store.ExtensionStore<ExamplePreferencesModel> {
    +
    +  @observable  enabled = false;
    +
    +  private constructor() {
    +    super({
    +      configName: "example-preferences-store",
    +      defaults: {
    +        enabled: false
    +      }
    +    });
    +  }
    +
    +  protected fromStore({ enabled }: ExamplePreferencesModel): void {
    +    this.enabled = enabled;
    +  }
    +
    +  toJSON(): ExamplePreferencesModel {
    +    return toJS({
    +      enabled: this.enabled
    +    }, {
    +      recurseEverything: true
    +    });
    +  }
    +}
    +
    +export const examplePreferencesStore = ExamplePreferencesStore.getInstance<ExamplePreferencesStore>();
    +
    +

    First, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled, which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, which is based on the ExamplePreferencesModel. The enabled field is added to the ExamplePreferencesStore class to hold the "live" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user.

    +

    Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store ("example-preferences-store") and the default (initial) value for the preference state (enabled: false). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. The enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore(). It is called when the store is being saved. +toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here.

    +

    Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance<ExamplePreferencesStore>(), and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton. Calling this function again will not create a new store.

    +

    The following example code, modified from the appPreferences guide demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

    +
    import { LensMainExtension } from "@k8slens/extensions";
    +import { examplePreferencesStore } from "./src/example-preference-store";
    +
    +export default class ExampleMainExtension extends LensMainExtension {
    +  async onActivate() {
    +    await examplePreferencesStore.loadExtension(this);
    +  }
    +}
    +
    +

    Here, examplePreferencesStore loads with examplePreferencesStore.loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. +Similarly, examplePreferencesStore must load in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
    +import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
    +import { examplePreferencesStore } from "./src/example-preference-store";
    +import React from "react";
    +
    +export default class ExampleRendererExtension extends LensRendererExtension {
    +
    +  async onActivate() {
    +    await examplePreferencesStore.loadExtension(this);
    +  }
    +
    +  appPreferences = [
    +    {
    +      title: "Example Preferences",
    +      components: {
    +        Input: () => <ExamplePreferenceInput preference={examplePreferencesStore}/>,
    +        Hint: () => <ExamplePreferenceHint/>
    +      }
    +    }
    +  ];
    +}
    +
    +

    Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension. There is no longer the need for the preference field in the ExampleRendererExtension class because the props for ExamplePreferenceInput is now examplePreferencesStore. +ExamplePreferenceInput is defined in ./src/example-preference.tsx:

    +
    import { Component } from "@k8slens/extensions";
    +import { observer } from "mobx-react";
    +import React from "react";
    +import { ExamplePreferencesStore } from "./example-preference-store";
    +
    +export class ExamplePreferenceProps {
    +  preference: ExamplePreferencesStore;
    +}
    +
    +@observer
    +export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
    +
    +  render() {
    +    const { preference } = this.props;
    +
    +    return (
    +      <Component.Checkbox
    +        label="I understand appPreferences"
    +        value={preference.enabled}
    +        onChange={v => { preference.enabled = v; }}
    +      />
    +    );
    +  }
    +}
    +
    +export class ExamplePreferenceHint extends React.Component {
    +  render() {
    +    return (
    +      <span>This is an example of an appPreference for extensions.</span>
    +    );
    +  }
    +}
    +
    +

    The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. +Everything else works as before, except that now the enabled state persists across Lens restarts because it is managed by the +examplePreferencesStore.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/guides/working-with-mobx/index.html b/v4.2.1/extensions/guides/working-with-mobx/index.html new file mode 100644 index 0000000000..cd72f005a7 --- /dev/null +++ b/v4.2.1/extensions/guides/working-with-mobx/index.html @@ -0,0 +1,1025 @@ + + + + + + + + + + + + + + + + + + + + + + Working with MobX - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Working with MobX#

    +

    Introduction#

    +

    Lens uses MobX on top of React's state management system. +The result is a more declarative state management style, rather than React's native setState mechanism.

    +

    You can review how React handles state management here.

    +

    The following is a quick overview:

    +
      +
    • React.Component is generic with respect to both props and state (which default to the empty object type).
    • +
    • props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component.
    • +
    • state is a component's internal state, and can be read by accessing the super-class field state.
    • +
    • state must be updated using the setState parent method which merges the new data with the old state.
    • +
    • React does some optimizations around re-rendering components after quick successions of setState calls.
    • +
    +

    How MobX Works:#

    +

    MobX is a package that provides an abstraction over React's state management system. The three main concepts are:

    +
      +
    • observable is a marker for data stored in the component's state.
    • +
    • action is a function that modifies any observable data.
    • +
    • computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count.
    • +
    +

    Further reading is available on the MobX website.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/index.html b/v4.2.1/extensions/index.html new file mode 100644 index 0000000000..f1730e5cf8 --- /dev/null +++ b/v4.2.1/extensions/index.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.

    +

    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.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/testing-and-publishing/bundling/index.html b/v4.2.1/extensions/testing-and-publishing/bundling/index.html new file mode 100644 index 0000000000..35b21b6756 --- /dev/null +++ b/v4.2.1/extensions/testing-and-publishing/bundling/index.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + Bundling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + +

    Bundling

    + + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/testing-and-publishing/publishing/index.html b/v4.2.1/extensions/testing-and-publishing/publishing/index.html new file mode 100644 index 0000000000..d37c81e078 --- /dev/null +++ b/v4.2.1/extensions/testing-and-publishing/publishing/index.html @@ -0,0 +1,1074 @@ + + + + + + + + + + + + + + + + + + + + + + Publishing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Publishing Extensions#

    +

    To be able to easily share extensions with users they need to be published somewhere. +Lens currently only supports installing extensions from NPM tarballs. +All hosted extensions must, therefore, be retrievable in a NPM tarball.

    +

    Places To Host Your Extension#

    +

    We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. +We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. +We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.

    +

    Publishing via NPM#

    +

    This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. +Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI (npm login) you will be ready to publish.

    +
      +
    • Run npm version <major|minor|patch> to bump the version of your extension by the appropriate amount.
    • +
    • Run npm publish to publish your extension to NPM
    • +
    • Run git push && git push --tags to push the commit that NPM creates to your git remote.
    • +
    +

    It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link.

    +
    npm view <extension-name> dist.tarball
    +
    +

    This will output the link that they will need to give to Lens to install your extension.

    +

    Publish via GitHub Releases#

    +

    Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. +We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. +The following will be a quick walk through on how to make the tarball which will be the released file.

    +

    Making a NPM Tarball of Your Extension#

    +

    While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform.

    +

    Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo:

    +
    npm pack
    +
    +

    This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/testing-and-publishing/testing/index.html b/v4.2.1/extensions/testing-and-publishing/testing/index.html new file mode 100644 index 0000000000..adce0495b6 --- /dev/null +++ b/v4.2.1/extensions/testing-and-publishing/testing/index.html @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + Testing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Testing Extensions#

    +

    Renderer Process Unit Testing#

    +

    UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library.

    +

    If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests.

    +

    For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon.

    +

    My component GlobalPageMenuIcon

    +
    import React from "react"
    +import { Component: { Icon } } from "@k8slens/extensions";
    +
    +const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => (
    +  <Icon
    +    material="trip_origin"
    +    onClick={() => navigate()}
    +    data-testid="global-page-menu-icon"
    +  />
    +)
    +
    +

    The test

    +
    import React from "react"
    +import { render, screen, fireEvent } from "@testing-library/react";
    +
    +import GlobalPageMenuIcon from "./GlobalPageMenuIcon";
    +
    +test("click called navigate()", () => {
    +    const navigate = jest.fn();
    +    render(<GlobalPageMenuIcon navigate={navigate} />);
    +    fireEvent.click(screen.getByTestId("global-page-menu-icon"));
    +    expect(navigate).toHaveBeenCalled();
    +  });
    +
    +

    In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components.

    +

    There are more example tests in the generator's template. Extend your tests based on the examples.

    +

    Main Process Unit Testing#

    +

    Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework.

    +

    If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.

    +

    Tips#

    +

    Console.log#

    +

    Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log(), note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer.

    +

    Renderer Process Logs#

    +

    In the Renderer process, console.log() is printed in the Console in Developer Tools (View > Toggle Developer Tools).

    +

    Main Process Logs#

    +

    Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.

    +

    macOS#

    +

    On macOS, view the Main process logs by running Lens from the terminal:

    +
    /Applications/Lens.app/Contents/MacOS/Lens
    +
    +

    You can also use Console.app to view the Main process logs.

    +

    Linux#

    +

    On Linux, you can access the Main process logs using the Lens PID. First get the PID:

    +
    ps aux | grep Lens | grep -v grep
    +
    +

    Then get the Main process logs using the PID:

    +
    tail -f /proc/[pid]/fd/1 # stdout (console.log)
    +tail -f /proc/[pid]/fd/2 # stdout (console.error)
    +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/extensions/typedoc-readme.md.tpl b/v4.2.1/extensions/typedoc-readme.md.tpl new file mode 100644 index 0000000000..6e23d197d5 --- /dev/null +++ b/v4.2.1/extensions/typedoc-readme.md.tpl @@ -0,0 +1,18 @@ +# Extension API Reference + +## Modules + +* [App](modules/_core_api_app_.md) +* [ClusterFeature](modules/_core_api_cluster_feature_.md) +* [EventBus](modules/_core_api_event_bus_.md) +* [Store](modules/_core_api_stores_.md) +* [Util](modules/_core_api_utils_.md) +* [Component](modules/_renderer_api_components_.md) +* [K8sApi](modules/_renderer_api_k8s_api_.md) +* [Navigation](modules/_renderer_api_navigation_.md) + +## Classes + +* [LensMainExtension](classes/lensmainextension.md) +* [LensRendererExtension](classes/lensrendererextension.md) + diff --git a/v4.2.1/extensions/usage/images/extensions.png b/v4.2.1/extensions/usage/images/extensions.png new file mode 100644 index 0000000000..5deb8e4bd2 Binary files /dev/null and b/v4.2.1/extensions/usage/images/extensions.png differ diff --git a/v4.2.1/extensions/usage/index.html b/v4.2.1/extensions/usage/index.html new file mode 100644 index 0000000000..aa75d60085 --- /dev/null +++ b/v4.2.1/extensions/usage/index.html @@ -0,0 +1,1032 @@ + + + + + + + + + + + + + + + + + + + + + + Using Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Using Extensions#

    +

    The features that Lens includes out-of-the-box are just the start. +Lens extensions let you add new features to your installation to support your workflow. +Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. +The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. +This is the Extensions management page where all the management of the extensions you want to use is done.

    +

    Extensions

    +

    Installing an Extension#

    +

    There are three ways to install extensions. +If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. +If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. +The third way is to move the extension into your ~/.k8slens/extensions (or C:\Users\<user>\.k8slens\extensions) folder and Lens will automatically detect it and install the extension.

    +

    Enabling or Disabling an Extension#

    +

    Go to the extension management page and click either the Enable or Disable buttons. +Extensions will be enabled by default when you first install them. +A disabled extension is not loaded by Lens and is not run.

    +

    Uninstalling an Extension#

    +

    If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/faq/index.html b/v4.2.1/faq/index.html new file mode 100644 index 0000000000..c69182db43 --- /dev/null +++ b/v4.2.1/faq/index.html @@ -0,0 +1,1147 @@ + + + + + + + + + + + + + + + + + + + + + + FAQ - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    FAQ#

    +

    What operating systems does Lens support?#

    +

    Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.

    +

    Lens application is not opening, what might be wrong?#

    +

    When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.

    +

    Why can't I add any clusters?#

    +

    When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.

    +

    Why Cluster dashboard is not opening?#

    +

    To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699.

    +

    Why I don't see anything on Cluster dashboard?#

    +

    Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.

    +

    Why I don't see any metrics or some of the metrics are not working?#

    +

    In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed.

    +

    Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.

    +

    Kubectl is not working in Lens terminal, what should I do?#

    +

    Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.

    +

    How can I configure Helm repositories?#

    +

    Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.

    +

    Where can I find application logs?#

    +

    Lens will store application logs to following locations depending on your operating system: +- MacOS: ~/Library/Logs/Lens/ +- Windows: %USERPROFILE%\AppData\Roaming\Lens\logs\ +- Linux: ~/.config/Lens/logs/

    +

    How can I see more verbose logs?#

    +

    You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens

    +

    Why Lens window rendering is broken?#

    +

    MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display. Same thing can happen with any of Electron applications or Chrome itself.

    +

    fuzzy lines

    +

    As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app.

    +

    First, open .bash_profile file from your terminal

    +
    open -a TextEdit.app ~/.bash_profile
    +
    +

    Then, add this line

    +
    export LENS_DISABLE_GPU=true
    +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/getting-started/images/color-theme.png b/v4.2.1/getting-started/images/color-theme.png new file mode 100644 index 0000000000..5e4f144560 Binary files /dev/null and b/v4.2.1/getting-started/images/color-theme.png differ diff --git a/v4.2.1/getting-started/images/disabled-telemetry-usage-tracking.png b/v4.2.1/getting-started/images/disabled-telemetry-usage-tracking.png new file mode 100644 index 0000000000..809a96056a Binary files /dev/null and b/v4.2.1/getting-started/images/disabled-telemetry-usage-tracking.png differ diff --git a/v4.2.1/getting-started/images/snap-store.png b/v4.2.1/getting-started/images/snap-store.png new file mode 100644 index 0000000000..5e652132c3 Binary files /dev/null and b/v4.2.1/getting-started/images/snap-store.png differ diff --git a/v4.2.1/getting-started/index.html b/v4.2.1/getting-started/index.html new file mode 100644 index 0000000000..4c3152aa52 --- /dev/null +++ b/v4.2.1/getting-started/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + Getting Started - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Getting Started#

    +

    Lens is lightweight and simple to install. You'll be up and running in just a few minutes.

    +

    System Requirements#

    +

    Review the System Requirements to check if your computer configuration is supported.

    +

    macOS#

    +
      +
    1. Download Lens for macOS.
    2. +
    3. Open the browser's download list and locate the downloaded archive.
    4. +
    5. Select the 'magnifying glass' icon to open the archive in Finder.
    6. +
    7. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad.
    8. +
    9. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options, Keep in Dock.
    10. +
    +

    Windows#

    +
      +
    1. Download the Lens installer for Windows.
    2. +
    3. Once it is downloaded, run the installer Lens-Setup-{version}.exe. This will only take a minute.
    4. +
    5. By default, Lens is installed under C:\users\{username}\AppData\Local\Programs\Lens.
    6. +
    +

    Linux#

    +

    See the Download Lens page for a complete list of available installation options.

    +

    After installing Lens manually (not using a package manager file such as .deb or .rpm) the following will need to be done to allow protocol handling. +This assumes that your linux distribution uses xdg-open and the xdg-* suite of programs for determining which application can handle custom URIs.

    +
      +
    1. Create a file called lens.desktop in either ~/.local/share/applications/ or /usr/share/applications (if you have permissions and are installing Lens for all users).
    2. +
    3. That file should have the following contents, with <path/to/executable> being the absolute path to where you have installed the unpacked Lens executable: +
      [Desktop Entry]
      +Name=Lens
      +Exec=<path/to/executable> %U
      +Terminal=false
      +Type=Application
      +Icon=lens
      +StartupWMClass=Lens
      +Comment=Lens - The Kubernetes IDE
      +MimeType=x-scheme-handler/lens;
      +Categories=Network;
      +
    4. +
    5. Then run the following command: +
      xdg-settings set default-url-scheme-handler lens lens.desktop
      +
    6. +
    7. If that succeeds (exits with code 0) then your Lens install should be set up to handle lens:// URIs.
    8. +
    +

    Snap#

    +

    Lens is officially distributed as a Snap package in the Snap Store:

    +

    Get it from the Snap Store

    +

    You can install it by running:

    +
    sudo snap install kontena-lens --classic
    +
    +

    Update Cadence#

    +

    Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available!

    +

    To stay current with the Lens features, you can review the release notes.

    +

    Next Steps#

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/getting-started/introductory-videos/index.html b/v4.2.1/getting-started/introductory-videos/index.html new file mode 100644 index 0000000000..5b7177a961 --- /dev/null +++ b/v4.2.1/getting-started/introductory-videos/index.html @@ -0,0 +1,917 @@ + + + + + + + + + + + + + + + + + + + + + + Introductory Videos - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/getting-started/preferences/index.html b/v4.2.1/getting-started/preferences/index.html new file mode 100644 index 0000000000..ff4a43385f --- /dev/null +++ b/v4.2.1/getting-started/preferences/index.html @@ -0,0 +1,1045 @@ + + + + + + + + + + + + + + + + + + + + + + Preferences - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Preferences#

    +

    Color Themes#

    +

    The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking.

    +
      +
    1. Go to File > Preferences (Lens > Preferences on Mac). Or follow this link.
    2. +
    3. Select your preferred theme from the Color Theme dropdown. +Color Theme
    4. +
    +

    Telemetry & Usage Tracking#

    +

    Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.

    +

    Disable Telemetry Reporting#

    +

    If you don't wish to send usage data to Mirantis, you can disable the "Telemetry & Usage Tracking" in the Lens preferences.

    +
      +
    1. Go to File > Preferences (Lens > Preferences on Mac). Or follow this link.
    2. +
    3. Scroll down to Telemetry & Usage Tracking
    4. +
    5. Uncheck Allow Telemetry & Usage Tracking.
    6. +
    +

    This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting. +Disable Telemetry & Usage Tracking

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/helm/images/helm-charts.png b/v4.2.1/helm/images/helm-charts.png new file mode 100644 index 0000000000..93548fca9e Binary files /dev/null and b/v4.2.1/helm/images/helm-charts.png differ diff --git a/v4.2.1/helm/index.html b/v4.2.1/helm/index.html new file mode 100644 index 0000000000..ac1d2cdc92 --- /dev/null +++ b/v4.2.1/helm/index.html @@ -0,0 +1,1039 @@ + + + + + + + + + + + + + + + + + + + + + + Using Helm Charts - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Using Helm Charts#

    +

    Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.

    +

    Helm Charts

    +

    Managing Helm Repositories#

    +

    Used Helm repositories are possible to configure in the Preferences. Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.

    +

    Installing a Helm Chart#

    +

    Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click "Install" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking "Install" button Lens will deploy the chart into the cluster.

    +

    Updating a Helm Release#

    +

    To update a Helm release, you can open the release details and modify the release values and click "Save" button. To upgrade or downgrade the release, click "Upgrade" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click "Upgrade" or "Upgrade and Close" button.

    +

    Deleting a Helm Release#

    +

    To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/img/favicon.ico b/v4.2.1/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.2.1/img/favicon.ico differ diff --git a/v4.2.1/img/lens-intro-video-screenshot.png b/v4.2.1/img/lens-intro-video-screenshot.png new file mode 100644 index 0000000000..2c5467b3f0 Binary files /dev/null and b/v4.2.1/img/lens-intro-video-screenshot.png differ diff --git a/v4.2.1/img/lens-logo-icon.svg b/v4.2.1/img/lens-logo-icon.svg new file mode 100644 index 0000000000..ede39244e5 --- /dev/null +++ b/v4.2.1/img/lens-logo-icon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + diff --git a/v4.2.1/img/play.svg b/v4.2.1/img/play.svg new file mode 100644 index 0000000000..a94d6e88ab --- /dev/null +++ b/v4.2.1/img/play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v4.2.1/index.html b/v4.2.1/index.html new file mode 100644 index 0000000000..75c8413697 --- /dev/null +++ b/v4.2.1/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Overview#

    +

    Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include:

    +
      +
    • Confidence that your clusters are properly setup and configured.
    • +
    • Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities.
    • +
    • The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business.
    • +
    +

    Watch this introductory video to see Lens in action:

    +

    Screenshot

    +

    Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab

    +

    Downloading Lens#

    +

    Download Lens for macOS, Windows, or Linux.

    +

    Quick Start#

    +

    Get up and running quickly by learning to add clusters.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.2.1/search/search_index.json b/v4.2.1/search/search_index.json new file mode 100644 index 0000000000..174fb015f5 --- /dev/null +++ b/v4.2.1/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example # If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label