The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/packages_api/runtime/angularcomponent.md

101 lines
2.1 KiB

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "AngularComponent"
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
type = "docs"
+++
## AngularComponent interface
Used to enable rendering of Angular components within a React component without losing proper typings.
<b>Signature</b>
```typescript
export interface AngularComponent
```
<b>Import</b>
```typescript
import { AngularComponent } from '@grafana/runtime';
```
## Example
```typescript
class Component extends PureComponent<Props> {
element: HTMLElement;
angularComponent: AngularComponent;
componentDidMount() {
const template = '<angular-component />' // angular template here;
const scopeProps = { ctrl: angularController }; // angular scope properties here
const loader = getAngularLoader();
this.angularComponent = loader.load(this.element, scopeProps, template);
}
componentWillUnmount() {
if (this.angularComponent) {
this.angularComponent.destroy();
}
}
render() {
return (
<div ref={element => (this.element = element)} />
);
}
}
```
<b>Methods</b>
| Method | Description |
| --- | --- |
| [destroy()](#destroy-method) | Should be called when the React component will unmount. |
| [digest()](#digest-method) | Can be used to trigger a re-render of the Angular component. |
| [getScope()](#getscope-method) | Used to access the Angular scope from the React component. |
### destroy method
Should be called when the React component will unmount.
<b>Signature</b>
```typescript
destroy(): void;
```
<b>Returns:</b>
`void`
### digest method
Can be used to trigger a re-render of the Angular component.
<b>Signature</b>
```typescript
digest(): void;
```
<b>Returns:</b>
`void`
### getScope method
Used to access the Angular scope from the React component.
<b>Signature</b>
```typescript
getScope(): any;
```
<b>Returns:</b>
`any`