BaseComponent class

コンポーネントの関連付けられたマニフェストで定義されているコンポーネント識別子を返します。

get componentId(): string;

プロパティ値

注釈

各クライアント側コンポーネントには、スクリプトの読み込みに sp-loader によって使用されるマニフェストが関連付けられています。これには、コンポーネントに関する追加のメタデータが含まれる場合があります。 マニフェストは、小文字の GUID 値を含むテキスト文字列を使用して一意に識別されます。

コンテキスト オブジェクトを使用して、コンポーネントに関連付けられている一般的なサービスと状態にアクセスします。

protected context?: BaseComponentContext;

プロパティ値

注釈

子クラスは、特殊化された型で再宣言することで、このフィールドをオーバーライドすることが期待されます。 これは読み取り専用プロパティを意味します。型は基底クラスで読み取り専用として宣言することはできません (コンストラクターの外部で初期化されるため)。ただし、子クラスでは読み取り専用として再宣言する必要があります。

コンポーネントのインスタンスの一意識別子。

get instanceId(): string;

プロパティ値

注釈

コンポーネントの実装は、ページに複数回読み込むことができます。 たとえば、コンポーネントがグラフ化 Web パーツの場合、この Web パーツの複数のインスタンスを SharePoint キャンバスに追加できます。 instanceId は、これらの各インスタンスを一意に識別します。

コンポーネントが既に破棄されている場合は true を返します。

get isDisposed(): boolean;

プロパティ値

クライアント側コンポーネントのマニフェストへのアクセスを提供します。 バーチャル

get manifest(): IClientSideComponentManifest;

プロパティ値

注釈

子クラスは、より特殊なマニフェスト型でこれをオーバーライドできます。

コンポーネントを破棄します。

dispose(): void;

戻り値

注釈

サード パーティのコードでは、通常、このメソッドを呼び出す必要はありません。Web パーツまたは拡張機能のライフサイクルが終了すると、自動的に呼び出されます。 コンポーネントが破棄されたときにカスタム クリーンアップを実行するには、 BaseComponent.onDispose() メソッドをオーバーライドします。

このイベント メソッドは、コンポーネントのライフサイクルの最後に呼び出されます。 関連付けられているリソースを解放し、未処理の要求を取り消す機会を提供します。

protected onDispose(): void;

戻り値