クラス: Designer

ReportDesigner.Designer

レポートデザイナのコンポーネント。

Table of contents

コンストラクタ

• constructor

アクセサ

• documentChanged

メソッド

• createReport
• focus
• getEditorAPI
• getNotificationsAPI
• getPanelsAPI
• getReport
• getReportPartsLibraries
• processCommand
• setActionHandlers
• setDataSourceTemplates
• setReport
• setReportPartsLibraries
• setResourceProvider

コンストラクタ

constructor

• new Designer(element, config?)

レポートデザイナコンポーネントのインスタンスを作成します。

パラメータ

名前	型	説明
element	string | object | Element	コンポーネントのホスト要素。
config?	DesignerConfig	デザイナの設定。

アクセサ

documentChanged

• get documentChanged(): Event<DocumentChangedEventArgs>

戻り値

Event<DocumentChangedEventArgs>

メソッド

createReport

▸ createReport(reportInfo, whenDirty?): Promise<void>

レポートを作成します。

パラメータ

名前	型	説明
reportInfo	NewReportInfo	ロードするレポート情報。
whenDirty?	WhenDirty	レポートがダーティ状態の場合に実行するアクション。

戻り値

Promise<void>

---

focus

▸ focus(): void

デザイナにフォーカスを戻します。

戻り値

void

---

getEditorAPI

▸ getEditorAPI(): Promise<EditorAPI>

デザイナを操作するためのAPIを取得します。

戻り値

Promise<EditorAPI>

---

getNotificationsAPI

▸ getNotificationsAPI(): Promise<NotificationsAPI>

通知パネルを取得します。

戻り値

Promise<NotificationsAPI>

---

getPanelsAPI

▸ getPanelsAPI(): Promise<PanelsAPI>

メニューおよびサイドバーにアクセスするためのAPIを取得します。

戻り値

Promise<PanelsAPI>

---

getReport

▸ getReport(): Promise<ReportInfo>

現在のレポートを取得します。

戻り値

Promise<ReportInfo>

---

getReportPartsLibraries

▸ getReportPartsLibraries(): Promise<ReportPartsLibrary[]>

利用可能なレポートパーツライブラリのリストを取得します。

戻り値

Promise<ReportPartsLibrary[]>

---

processCommand

▸ processCommand(cmd): Promise<void>

コマンドを処理します。

パラメータ

名前	型	説明
cmd	DesignerCommand	コマンド名。

戻り値

Promise<void>

---

setActionHandlers

▸ setActionHandlers(actionHandlers): Promise<void>

アクションハンドラを設定します。

パラメータ

名前	型
actionHandlers	ActionHandlers

戻り値

Promise<void>

---

setDataSourceTemplates

▸ setDataSourceTemplates(templates): Promise<void>

データソーステンプレートを設定します。

パラメータ

名前	型	説明
templates	DataSourceTemplate[]	データソーステンプレートのリスト。

戻り値

Promise<void>

---

setReport

▸ setReport(report, whenDirty?, isDirtyInitial?): Promise<void>

レポートを設定します。

パラメータ

名前	型	説明
report	Report	ロードするレポート情報。
whenDirty?	WhenDirty	レポートがダーティ状態の場合に実行するアクション。
isDirtyInitial?	boolean	レポートがロード後のダーティ状態の初期値。

戻り値

Promise<void>

---

setReportPartsLibraries

▸ setReportPartsLibraries(libraries): Promise<void>

利用可能なレポートパーツライブラリのリストを設定します。

パラメータ

名前	型
libraries	ReportPartsLibrary[]

戻り値

Promise<void>

---

setResourceProvider

▸ setResourceProvider(resourceProvider): Promise<void>

リソースプロバイダを設定します。

パラメータ

名前	型	説明
resourceProvider	Partial<ResourceProvider>	リソースプロバイダ。

戻り値

Promise<void>