名前空間: ReportDesigner

Table of contents

クラスes

• Designer

インターフェイス

• ActionHandlers
• ResourceProvider

型の別名

• ColorTheme
• ColorThemeItem
• ColorThemeShades
• ColorThemeType
• CustomInitTemplates
• DataSetTemplate
• DataSourceTemplate
• DesignerAppBarControlItem
• DesignerCommand
• DesignerConfig
• DocumentChangedEventArgs
• EditorAPI
• FontSet
• ImageResourceInfo
• MenuCssIcon
• MenuIcon
• NewReport
• NewReportInfo
• NotificationsAPI
• PanelsAPI
• PropertyDescriptor
• PropertyDisplayMode
• Report
• ReportDefinition
• ReportInfo
• ReportLink
• ReportResourceInfo
• ReportType
• SaveAsResult
• SaveNewReportInfo
• SaveReportInfo
• SaveResult
• StylesheetResourceInfo
• ThemeInfo
• ThemeResourceInfo
• WhenDirty

変数

• ColorThemes

型の別名

ColorTheme

Ƭ ColorTheme: Object

型宣言

名前	型
backgroundMain	string
backgroundPanels	string
error?	ColorThemeItem
fontFamily?	string
name	string
neutral?	ColorThemeItem
primary?	ColorThemeItem
secondary?	ColorThemeItem
type	ColorThemeType
warning?	ColorThemeItem

---

ColorThemeItem

Ƭ ColorThemeItem: string | ColorThemeShades

---

ColorThemeShades

Ƭ ColorThemeShades: Object

型宣言

名前	型
base	string
dark	string
darkMedium	string
darker	string
light	string
lightMedium	string
lighter	string
medium	string
veryDark	string
veryLight	string

---

ColorThemeType

Ƭ ColorThemeType: "light" | "dark"

---

CustomInitTemplates

Ƭ CustomInitTemplates: Object

型宣言

名前	型
imperialTemplates?	Report[]
metricTemplates?	Report[]

---

DataSetTemplate

Ƭ DataSetTemplate: Object

データパネルのデータセットテンプレートを定義します。

型宣言

名前	型	説明
canEdit?	boolean	テンプレートから作成されたDataSetを編集できるかどうかを指示します。
id	string	テンプレート ID。
nestedTemplates?	DataSet[]	ネストされたデータセットのRDLX定義。
shouldEdit?	boolean	デザイナを編集ダイアログを表示するようにします。
template	DataSet	DataSetのRDLX定義。
title	string	タイトル。

---

DataSourceTemplate

Ƭ DataSourceTemplate: Object

データパネルのデータソーステンプレートを定義します。

型宣言

名前	型	説明
canEdit?	boolean	テンプレートから作成されたDataSetを編集できるかどうかを指示します。
datasets?	DataSetTemplate[]	テンプレートに基づくデータソースのDataSetテンプレート。
id	string	テンプレート ID。
shouldEdit?	boolean	デザイナを編集ダイアログを表示するようにします。
template	DataSource	DataSourceのRDLX定義。
title	string	タイトル。

---

DesignerAppBarControlItem

Ƭ DesignerAppBarControlItem: Object

型宣言

名前	型
badge?	{ content?: string ; customCSS?: string ; level?: "warning" | "error" ; position?: string ; rounded?: boolean }
badge.content?	string
badge.customCSS?	string
badge.level?	"warning" | "error"
badge.position?	string
badge.rounded?	boolean
customCSS?	string
disabled?	boolean
icon?	{ content: unknown ; type: "svg" }
icon.content	unknown
icon.type	"svg"
id?	string
title?	string
type	"about" | "button"
onClick?	(e: MouseEvent) => void

---

DesignerCommand

Ƭ DesignerCommand: "save" | "saveAs" | "create" | "open" | "render"

コマンド名。

---

DesignerConfig

Ƭ DesignerConfig: Object

デザイナの構成。

型宣言

名前	型	説明
allowInlineEditing?	"True" | "False" | "Auto"	allowInlineEditingが 'False' の場合、インラインエディタ（テキストボックスをクリックして手動で値を入力できる機能）および DataFieldPicker は無効になります。 Example: javascript designerOptions.allowInlineEditing = 'False'; default 'Auto'
appBar?	{ contextActionsTab?: { visible: boolean } ; homeTab?: { visible: boolean } ; parametersTab?: { visible: boolean } ; visible: boolean }	リボンの設定
appBar.aboutButton?	{ visible: boolean }	[製品情報]ボタンの設定
appBar.aboutButton.visible	boolean	[製品情報]ボタンをリボンに表示するかどうかを指定します。デフォルト値はtrueです。
appBar.contextActionsTab?	{ visible: boolean }	［レポート］タブの設定
appBar.contextActionsTab.visible	boolean	［レポート］タブをリボンに表示するかどうかを指定します。デフォルト値はtrueです。
appBar.homeTab?	{ visible: boolean }	［ホーム］タブの設定
appBar.homeTab.visible	boolean	［ホーム］タブをリボンに表示するかどうかを指定します。デフォルト値はtrueです。
appBar.parametersTab?	{ visible: boolean }	［パラメータ］タブの設定
appBar.parametersTab.visible	boolean	［パラメータ］タブをリボンに表示するかどうかを指定します。デフォルト値はtrueです。［レポート］タブをリボンに表示するかどうかを指定します。デフォルト値はtrueです。
appBar.visible	boolean	リボンを表示するかどうかを指定します。デフォルト値はtrueです。
customInitTemplates?	CustomInitTemplates	レポートおよびレポートアイテムのデフォルト値を持つテンプレート。
data?	{ commonValues?: { visible: boolean } ; dataSets?: { canModify: boolean ; visible: boolean } ; dataSources?: { canModify: boolean ; visible: boolean } ; dataTab?: { visible: boolean } ; parameters?: { canModify: boolean ; visible: boolean } }	［データ］タブの設定
data.commonValues?	{ visible: boolean }	-
data.commonValues.visible	boolean	［共通の値］セクションを表示するかどうかを指定します。デフォルト値はtrueです。
data.dataSets?	{ canModify: boolean ; visible: boolean }	-
data.dataSets.canModify	boolean	データセットを変更（追加／編集／削除）できるかどうかを指定します。デフォルト値はfalseです。
data.dataSets.visible	boolean	［データセット］セクションを表示するかどうかを指定します。デフォルト値はtrueです。
data.dataSources?	{ canModify: boolean ; visible: boolean }	［データソース］セクションの設定
data.dataSources.canModify	boolean	データソースを変更（追加／編集／削除）できるかどうかを指定します。デフォルト値はfalseです。
data.dataSources.visible	boolean	［データソース］セクションを表示するかどうかを指定します。デフォルト値はtrueです。
data.dataTab?	{ visible: boolean }	-
data.dataTab.visible	boolean	データタブを表示するかどうかを指定します。。デフォルト値はtrueです。
data.parameters?	{ canModify: boolean ; visible: boolean }	-
data.parameters.canModify	boolean	パラメータを変更（追加／編集／削除）できるかどうかを指定します。デフォルト値はtrueです。
data.parameters.visible	boolean	［パラメータ］セクションを表示するかどうかを指定します。デフォルト値はtrueです。
dateFormats?	string[]	サポートされる日付形式のリストを指定します。
disableFocusTimer?	boolean	デフォルトでは、Tabキーが押された後、フォーカスされた要素（ボタンなど）は短時間のみで強調表示されます。この設定により、フォーカスされた要素が永続的に強調表示されます。デフォルト値はfalseです。
disableHistoryHotkeys?	boolean	デザイナの「元に戻す」「やり直し」のショートカットキーの有効／無効を設定します。デフォルト値はtrueです。
disableOpenSaveHotkeys?	boolean	trueに設定した場合、デフォルトの「レポートを開く」および「レポートの保存」のホットキーが無効になります。
disableSystemClipboard?	boolean	システムクリップボードの使用を無効にします。デザイナインスタンス間のコピー＆ペーストは、同じドメインの同じブラウザでのみ機能します。
editor?	{ gridSize?: string ; rulers?: { snapStep?: { cm: number ; in: number } ; visible: boolean } ; showGrid?: boolean ; snapToGrid?: boolean ; snapToGuides?: boolean }	エディタの設定
editor.gridSize?	string	デフォルトのグリッドの幅を指定します。単位がcmの場合、デフォルト値は0.5cm。それ以外の場合、デフォルト値は0.25in。
editor.rulers?	{ snapStep?: { cm: number ; in: number } ; visible: boolean }	ルーラーの設定
editor.rulers.snapStep?	{ cm: number ; in: number }	寸法の単位を指定します。デフォルトでは、inの場合は0.25、cmの場合は0.5。
editor.rulers.snapStep.cm	number	-
editor.rulers.snapStep.in	number	-
editor.rulers.visible	boolean	デフォルトでルーラーを表示するかどうかを指定します。
editor.showGrid?	boolean	デフォルトでグリッドを表示するか非表示にするかを指定します。
editor.snapToGrid?	boolean	snapToGridオプションのデフォルト値を指定します。デフォルト値はfalseです。
editor.snapToGuides?	boolean	snapToGuidesプションのデフォルト値を指定します。デフォルト値はfalseです。
fontSet?	FontSet	使用可能なフォントのセットを設定します。
language?	string	アプリケーションの言語。たとえば、「en」、「ja」、「zh」などです。デフォルト値は「en」です。
lockLayout?	boolean	lockLayoutを有効にすると、レポートレイアウトに新しいアイテムを追加したり、既存のアイテムを削除したりできません。レポートに既に存在するアイテムのプロパティのみを変更できます。
menu?	{ documentExplorer?: { visible: boolean } ; groupEditor?: { visible: boolean } ; layerEditor?: { visible: boolean } ; logo?: { custom?: MenuIcon ; visible?: boolean } ; toolBox?: { visible: boolean } ; visible: boolean }	メニューの設定
menu.documentExplorer?	{ visible: boolean }	エクスプローラの設定
menu.documentExplorer.visible	boolean	［エクスプローラ］ボタンを表示するかどうかを指定します。デフォルト値はtrueです。
menu.groupEditor?	{ visible: boolean }	グループエディタの設定
menu.groupEditor.visible	boolean	［グループエディタ］ボタンを表示するかどうかを指定します。デフォルト値はtrueです。
menu.layerEditor?	{ visible: boolean }	レイヤーの設定
menu.layerEditor.visible	boolean	［レイヤー］ボタンを表示するかどうかを指定します。デフォルト値はtrueです。
menu.logo?	{ custom?: MenuIcon ; visible?: boolean }	ロゴの設定
menu.logo.custom?	MenuIcon	メニューに表示されるカスタムロゴを設定します。
menu.logo.visible?	boolean	メニューにロゴを表示するかどうかを指定します。デフォルト値はtrueです。
menu.toolBox?	{ visible: boolean }	ツールボックスの設定
menu.toolBox.visible	boolean	ツールボックスを表示するかどうかを指定します。デフォルト値はtrueです。
menu.visible	boolean	メニューを表示するかどうかを指定します。デフォルト値はtrueです。
propertyGrid?	{ collapsibleCategories?: { enabled?: boolean } ; mode?: "Basic" | "Advanced" ; propertiesTab?: { visible?: boolean } ; saveExpandEditorsState?: { enabled?: boolean } }	プロパティモードの設定
propertyGrid.collapsibleCategories?	{ enabled?: boolean }	-
propertyGrid.collapsibleCategories.enabled?	boolean	trueに設定すると、プロパティモードのカテゴリが折りたたみ可能になり、展開または折りたたみ状態が保存されます。
propertyGrid.mode?	"Basic" | "Advanced"	デフォルトのプロパティモードを指定します。
propertyGrid.propertiesTab?	{ visible?: boolean }	-
propertyGrid.propertiesTab.visible?	boolean	［プロパティ］タブを表示するかどうかを指定します。デフォルト値はtrueです。
propertyGrid.saveExpandEditorsState?	{ enabled?: boolean }	-
propertyGrid.saveExpandEditorsState.enabled?	boolean	trueに設定すると、エディタの展開または折りたたみ状態が保存されます。
reportPartsLibraries?	ReportPartsLibrary[]	レポートパーツのライブラリに関する設定を指定します。
statusBar?	{ gridSizeEditor?: { visible: boolean } ; propertiesModeButton?: { visible: boolean } ; rulersButton?: { visible: boolean } ; toggleGridButton?: { visible: boolean } ; toggleUnitsButton?: { visible: boolean } ; visible: boolean }	ステータスバーの設定
statusBar.gridSizeEditor?	{ visible: boolean }	-
statusBar.gridSizeEditor.visible	boolean	［グリッドの幅］エディタを表示するかどうかを指定します。デフォルト値はtrueです。
statusBar.propertiesModeButton?	{ visible: boolean }	-
statusBar.propertiesModeButton.visible	boolean	プロパティモードを表示するかどうかを指定します。。デフォルト値はtrueです。
statusBar.rulersButton?	{ visible: boolean }	-
statusBar.rulersButton.visible	boolean	ルーラーを表示するかどうかを指定します。デフォルト値はtrueです。
statusBar.toggleGridButton?	{ visible: boolean }	-
statusBar.toggleGridButton.visible	boolean	［グリッド］を表示するかどうかを指定します。デフォルト値はtrueです。
statusBar.toggleUnitsButton?	{ visible: boolean }	-
statusBar.toggleUnitsButton.visible	boolean	寸法ボタンを表示するかどうかを指定します。デフォルト値はtrueです。
statusBar.visible	boolean	ステータスバーを表示するかどうかを指定します。デフォルト値はtrueです。
storeUserPreferences?	boolean	storeUserPreferencesが有効な場合、ユーザー設定はブラウザに保存されます。無効な場合、この機能は使用できません。デフォルト値はtrueです。
themeConfig?	{ initialTheme?: BuiltInUITheme ; themeSelector?: { availableThemes?: BuiltInUITheme[] ; isEnabled?: boolean } }	デザイナのテーマに関する様々な設定を行います。
themeConfig.initialTheme?	BuiltInUITheme	初期表示に適用されるテーマを設定します。デフォルト値はDefaultです。
themeConfig.themeSelector?	{ availableThemes?: BuiltInUITheme[] ; isEnabled?: boolean }	-
themeConfig.themeSelector.availableThemes?	BuiltInUITheme[]	ユーザーが選択可能なテーマのリスト設定します。使用可能なテーマは内蔵のテーマのみです。デフォルト値：["System", "Default", "DefaultDark", "DarkOled", "HighContrast", "HighContrastDark", "ActiveReports", "ActiveReportsDark"]
themeConfig.themeSelector.isEnabled?	boolean	テーマピッカーを表示するかどうかを指定します。デフォルト値はtrueです。
toolBar?	{ visible: boolean }	ツールバーの設定
toolBar.visible	boolean	ツールバーを表示するかどうかを指定します。デフォルト値はtrueです。
units?	"in" | "cm"	デフォルトの寸法の単位を指定します。デフォルト値は「in」です。
filterProperties?	(descriptors: PropertyDescriptor[], item: Record<string, any>) => PropertyDescriptor[]	記述子を再配置する必要がある順序で、フィルタされた記述子の配列を返します。

---

DocumentChangedEventArgs

Ƭ DocumentChangedEventArgs: Object

型宣言

名前	型	説明
definition	Report	RDLXレポートの定義。
isDirty	boolean	レポートがダーティ（保存されていない）状態の場合はTrue。

---

EditorAPI

Ƭ EditorAPI: Object

レポートおよび選択されたアイテムで使用できる共通のアクションに関する情報

型宣言

名前	型
canCopy	() => boolean
canCut	() => boolean
canDelete	() => boolean
canPaste	() => boolean
canRedo	() => boolean
canUndo	() => boolean
copy	() => void
cut	() => void
delete	() => void
paste	() => void
redo	() => void
undo	() => void

---

FontSet

Ƭ FontSet: "default" | "registered" | "all"

フォントのセット。

default：事前定義されたフォント。
registered：FontStoreに登録されているフォント。
all：FontStoreフォントで登録済みの定義済み。

---

ImageResourceInfo

Ƭ ImageResourceInfo: Object

画像の情報を表します。

型宣言

名前	型	説明
displayName?	string	リソースの表示名。
id	string	リソースID。
mimeType	string	MIMEの種類。
thumbnail?	string	サムネイル。

---

MenuCssIcon

Ƭ MenuCssIcon: Object

型宣言

名前	型
class	string
type	"css"

---

MenuIcon

Ƭ MenuIcon: MenuCssIcon

---

NewReport

Ƭ NewReport: Object

作成する新しいレポートを表すレポート情報。

型宣言

名前	型	説明
displayName?	string	レポートの表示名。
id?	string	レポートID。
masterReportId?	string	マスターレポートID。
reportType	ReportType	レポートの種類。

---

NewReportInfo

Ƭ NewReportInfo: Object

新しいレポートの情報。

型宣言

名前	型	説明
masterReportId?	string	マスターレポートID。
reportType	ReportType	レポートの種類。

---

NotificationsAPI

Ƭ NotificationsAPI: Object

型宣言

名前	型
dismissAll	() => void
error	(caption: string, errorText?: string) => void
info	(caption: string, text?: string) => void
send	(level: "info" | "warning" | "error", caption: string, content?: string) => void
warning	(caption: string, warningText?: string) => void

---

PanelsAPI

Ƭ PanelsAPI: Object

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

型宣言

名前	型	説明
menu	{ close: () => void ; open: (id: string) => void ; pin: () => void }	メニューに関するAPI
menu.close	[object Object]	-
menu.open	[object Object]	-
menu.pin	[object Object]	-
sidebar	{ close: () => void ; open: (id: string) => void }	サイドバーに関するAPI
sidebar.close	[object Object]	-
sidebar.open	[object Object]	-

---

PropertyDescriptor

Ƭ PropertyDescriptor: Object

型宣言

名前	型	説明
category	string	プロパティのグループ化を指定します。
label	string	プロパティのラベルを指定します。
mode	PropertyDisplayMode	エディタを表示するモードを指定します。
type	string	描画されるエディタのタイプを指定します。
valuePath	string	objectValue内のプロパティの値へのパス。

---

PropertyDisplayMode

Ƭ PropertyDisplayMode: "simple" | "advanced" | "both"

---

Report

Ƭ Report: ReportLink | ReportDefinition

IDまたは定義でレポートを表すレポート情報。

---

ReportDefinition

Ƭ ReportDefinition: Object

定義でレポートを表すレポート情報。

型宣言

名前	型	説明
definition	Report	RDLXレポートの定義。
displayName?	string	レポートの表示名。
id?	string	レポートID。

---

ReportInfo

Ƭ ReportInfo: Object

現在のレポート情報を表します。

型宣言

名前	型	説明
definition	Report	RDLXレポートの定義。
displayName	string	レポートの表示名。
id	string | null	レポートID。
isDirty	boolean	レポートがダーティ（保存されていない）状態の場合はTrue。

---

ReportLink

Ƭ ReportLink: Object

IDでレポートを表すレポート情報。

型宣言

名前	型	説明
displayName?	string	レポートの表示名。
id	string	レポートID。

---

ReportResourceInfo

Ƭ ReportResourceInfo: Object

外部リソース情報を表します。

型宣言

名前	型	説明
displayName?	string	リソースの表示名。
id	string	リソースID。

---

ReportType

Ƭ ReportType: "CPL" | "FPL" | "Pageless"

レポートの種類

CPL：RDLレポート
FPL：ページレポート
Pageless：ダッシュボード

---

SaveAsResult

Ƭ SaveAsResult: Object

「新しいレポートの保存」操作の結果を表します。

型宣言

名前	型	説明
displayName?	string	レポートの表示名。
id	string	新しいレポートID。

---

SaveNewReportInfo

Ƭ SaveNewReportInfo: Object

新しいレポートとして保存される現在のレポート情報。

型宣言

名前	型	説明
definition	Report	現在のRDLXレポートの定義。
displayName?	string	現在のレポートの表示名。
id?	string	現在のレポートID。

---

SaveReportInfo

Ƭ SaveReportInfo: Object

保存する現在のレポート情報。

型宣言

名前	型	説明
definition	Report	現在のRDLXレポートの定義。
displayName?	string	現在のレポートの表示名。
id	string	現在のレポートID。

---

SaveResult

Ƭ SaveResult: Object

「レポートの保存」操作の結果を表します。

型宣言

名前	型	説明
displayName?	string	保存後のレポートの表示名。

---

StylesheetResourceInfo

Ƭ StylesheetResourceInfo: Object

外部スタイルシートの情報を表します。

型宣言

名前	型	説明
content	Stylesheet	スタイルシートの内容。
id	string	リソースID。

---

ThemeInfo

Ƭ ThemeInfo: Object

レポートのテーマの短い表現。

型宣言

名前	型	説明
Accent1	string	「アクセント1」テーマ色
Accent2	string	「アクセント2」テーマ色。
Accent3	string	「アクセント3」テーマ色。
Accent4	string	「アクセント4」テーマ色。
Accent5	string	「アクセント5」テーマ色。
Accent6	string	「アクセント6」テーマ色。
Dark1	string	「濃色1」テーマ色
Dark2	string	「濃色2」テーマ色
Light1	string	「淡色1」テーマ色
Light2	string	「淡色2」テーマ色
MajorFontFamily	string	メジャーフォントの設定。
MinorFontFamily	string	マイナーフォントの設定。

---

ThemeResourceInfo

Ƭ ThemeResourceInfo: Object

テーマの情報を表します。

型宣言

名前	型	説明
displayName?	string	リソースの表示名。
id	string	リソースID。
info	ThemeInfo	テーマの短い表現。

---

WhenDirty

Ƭ WhenDirty: "ask" | "override" | "throw"

レポートがダーティ状態の場合に実行するアクションを表します。

ask: 確認ダイアログを表示します。
override: ダーティなレポートをオーバーライドします。
Throw: エラーを発生します。

変数

ColorThemes

• ColorThemes: Record<BuiltInColorTheme, ColorTheme>

組み込みのUIカラーテーマを含みます。