GrapeCity ActiveReports for .NET 14.0J
サーバーAPIのオブジェクト
ActiveReportsユーザーガイド > 概念 > ActiveReports Webデザイナ > サーバーAPIのオブジェクト
baseServerApi.jsには、レポート、データ、テーマ、画像、およびレポートテンプレートなどに関連するWebデザイナの操作に必要な機能が含まれています。
メモ:以下のいくつかのプロパティと機能は、ActiveReports for .NETと関連しませんが、Webデザイナを正常に動作させるために必要であるため、予約済みとしてマークされています。(WebデザイナはActiveReports for .NETだけではなく、ActiveReports Server(提供終了)でも使用されています。)

レポート

getReportsList関数

パラメータ 戻り値の型 レスポンス
getReportsList() Promise Array<ReportsListItem>

ReportsListItemオブジェクト

コードのコピー
type ReportsListItem = {
  _id: string, // レポートのID
  Name: string, // レポート名
  IsCpl: boolean, // レポートがRDLかFPLかを指定します。
  Type: 'PageReport', // 予約済み:「PageReport」のみがサポートされています。
  $effectivePermissions: 'All', // 予約済み:「すべて」のみがサポートされています。
}

getReportContent関数

パラメータ 戻り値の型 レスポンス
getReportContent(options: GetReportContentOptions) Promise レポートJSONモデル

GetReportContentOptionsオブジェクト

コードのコピー
type GetReportContentOptions {
  id: string, // レポートのID
  version: null, // 予約済み:「null」のみがサポートされています。
}

getReportRevisions関数(予約済み)

パラメータ 戻り値の型 レスポンス
getReportRevisions(options: GetReportRevisionsOptions) Promise Array<ReportRevision>

GetReportRevisionsOptionsオブジェクト

コードのコピー
type GetReportRevisionsOptions {
id: string, // レポートのID
}

ReportRevisionオブジェクト

コードのコピー
type ReportRevision = {
_id: string, // レポートのID
Name: string, // レポート名
IsCpl: boolean, // レポートがRDLかFPLかを指定します。
Type: 'PageReport', // 予約済み:「PageReport」のみがサポートされています。
$effectivePermissions: 'All', // 予約済み:「すべて」のみがサポートされています。
}

saveNewReport関数

パラメータ 戻り値の型 レスポンス
saveNewReport(options: SaveNewReportOptions) Promise SaveReportResponse

SaveNewReportOptionsオブジェクト

コードのコピー
type SaveNewReportOptions = {
  name: string, // レポート名
  content: object, // レポートJSONモデル
}

SaveReportResponseオブジェクト

コードのコピー
type SaveReportResponse = {
  Id: string, // 保存されたレポートのID
}

saveExistingReport関数

パラメータ 戻り値の型 レスポンス
saveExistingReport(options: SaveExistingReportOptions) Promise SaveReportResponse

SaveExistingReportOptionsオブジェクト

コードのコピー
type SaveExistingReportOptions = {
  id: string, // レポートのID
  content: object, // レポートJSONモデル
}

saveTemporaryReport関数

パラメータ 戻り値の型 レスポンス
saveTemporaryReport(options: SaveTemporaryReportOptions) Promise SaveReportResponse

SaveTemporaryReportOptionsオブジェクト

コードのコピー
type SaveTemporaryReportOptions = {
  name: string, // レポート名
  content: object, // レポートJSONモデル
}

deleteTemporaryReport関数

Viewerコントロールを閉じて「デザイナ」ビューに戻す時に、一時ファイルを削除するために使用されます。

パラメータ 戻り値の型 レスポンス
deleteTemporaryReport(options: DeleteTemporaryReportOptions) Promise DeleteReportResponse

DeleteTemporaryReportOptionsオブジェクト

コードのコピー
type DeleteTemporaryReportOptions = {
  id: string, // レポートのID
}

DeleteReportResponseオブジェクト

コードのコピー
type DeleteReportResponse = {
  Id: string, // 削除されたレポートのID
}

データ

getDataSetsList関数

パラメータ 戻り値の型 レスポンス
getDataSetsList() Promise Array<DataSetsListItem>

DataSetsListItemオブジェクト

コードのコピー
type DataSetsListItem = {
  id: string, // データセットID
  name: string, // データセット名
  version: null, // 予約済み:「null」のみがサポートされています。
}

getDataSourcesAndDataSets関数

パラメータ 戻り値の型 レスポンス
getDataSourcesAndDataSets(options: GetDataSourcesAndDataSetsOptions) Promise GetDataSourcesAndDataSetsResponse

canEditDataSource関数

パラメータ 戻り値の型 レスポンス
canEditDataSource(options: CanEditDataSourceOptions) Promise GetDataSourcesAndDataSetsResponse

CanEditDataSourceOptionsオブジェクト

コードのコピー
type CanEditDataSourceOptions = {
    /** データソース */
    dataSource: DataSource;
    /** データソースのデータプロバイダ */
    dataProvider: string;
};

canAddDataSetForDataSource関数

パラメータ 戻り値の型 レスポンス
canAddDataSetForDataSource(options: CanAddDataSetForDataSourceOptions)) Promise GetDataSourcesAndDataSetsResponse

CanAddDataSetForDataSourceOptionsオブジェクト

コードのコピー
type CanAddDataSetForDataSourceOptions = {
    /** データソース */
    dataSource: DataSource;
    /** データソースのデータプロバイダ */
    dataProvider: string;
};

canEditDataSet関数

パラメータ 戻り値の型 レスポンス
canEditDataSet:(options: CanEditDataSetOptions) Promise GetDataSourcesAndDataSetsResponse

CanEditDataSetOptionsオブジェクト

コードのコピー
type CanEditDataSetOptions = {
    /** データセット */
    dataSet: DataSet;
    /** データセットの親データソースのデータプロバイダ */
    dataProvider: string;
};

initDataSetForDataSource関数

パラメータ 戻り値の型 レスポンス
 initDataSetForDataSource:(options: InitDataSetForDataSourceOptions) Promise

GetDataSourcesAndDataSetsResponse

InitDataSetForDataSourceOptionsオブジェクト

コードのコピー
type InitDataSetForDataSourceOptions = {
    /** データソース */
    dataSource: DataSource;
    /** データソースのデータプロバイダ */
    dataProvider: string;
    /** 初期化されるデータセット名 */
    dataSetName: string;
};

getDataSetProperties関数

パラメータ 戻り値の型 レスポンス
 getDataSetProperties:(options: GetDataSetPropertiesOptions) Promise

GetDataSourcesAndDataSetsResponse

GetDataSetPropertiesOptionsオブジェクト

コードのコピー
type GetDataSetPropertiesOptions = {
    /** データセットの親データソースのデータプロバイダ */
    dataProvider: string;
};

GetDataSetPropertiesResponseオブジェクト

コードのコピー
type DataSetProperty = 'name' | 'commandType' | 'query' | 'fields' | 'calculatedFields' | 'parameters' | 'filters'  | 'caseSensitivity' | 'collation' | 'kanatypeSensitivity' | 'widthSensitivity' | 'accentSensitivity';

getDataSetSchema関数

パラメータ 戻り値の型 レスポンス
 getDataSetSchema(options: GetDataSetSchemaOptions) Promise

GetDataSourcesAndDataSetsResponse

GetDataSetSchemaOptionsオブジェクト

コードのコピー
type GetDataSetSchemaOptions = {
    /** データセット */
    dataSet: DataSet;
    /** データセットの親データソース */
    dataSource: DataSource;
};

GetDataSetSchemaResponseオブジェクト

コードのコピー
type GetDataSetSchemaResponse = {
    /** データセットのフィールド */
    fields: Array<Field>;
    /** データセットクエリパラメータ */
    parameters: Array<QueryParameter>;
};

getDataSourcesAndDataSets関数

パラメータ 戻り値の型 レスポンス
getDataSourcesAndDataSets(options: GetDataSourcesAndDataSetsOptions) Promise GetDataSourcesAndDataSetsResponse

GetDataSourcesAndDataSetsOptionsオブジェクト

コードのコピー
type GetDataSourcesAndDataSetsOptions = {
  dataSetInfo: {
    id: string, // データセットID
    name: string, // データセット名
    version: null, // 予約済み:「null」のみがサポートされています。  
 },
  dataSourceInfo: object, // 予約済み
  reportDataSets: Array<DataSet>, // レポートで使用されるデータセット
  reportDataSources: Array<DataSource>, // レポートで使用されるデータソース
}

GetDataSourcesAndDataSetsResponseオブジェクト

コードのコピー
type GetDataSourcesAndDataSetsResponse = {
  dataSources: Array<DataSource>,
  dataSets: Array<DataSet>,
}

getDataSetContent関数

この関数はgetDataSourcesAndDataSets関数で使用されることを目的としています。応答はdataSetContentオブジェクトで、データセットとデータソースを作成するために必要な情報を格納できます。

パラメータ 戻り値の型 レスポンス
getDataSetContent(options: GetDataSetContentOptions) Promise dataSetContent: object

GetDataSetContentOptionsオブジェクト

コードのコピー
type GetDataSetContentOptions = {
  id: string, // データセットID
}

DataSourceおよびDataSetオブジェクト

以下は、DataSourceおよびDataSetの基本的なプロパティを示しています。DataSourceDataSetのオブジェクトモデルは、RDLXレポート定義でそれぞれの構造体と相関しています。

コードのコピー
type DataSource = {
  Name: string, // データソース名
  ConnectionProperties: {
    ConnectString: string, // 接続文字列
    DataProvider: string, // データプロバイダ(オンラインヘルプを参照してください。)
  },
  // その他のプロパティについては、オンラインヘルプを参照してください。
}
type DataSet = {
  Name: string, // データセット名
  Fields: Array<Field>, // データセットのフィールド
  Query: {
    DataSourceName: string, // データソース名
    CommandType: 'Text' | 'StoredProcedure', // コマンドの種類
    CommandText: string, // コマンドテキスト
    QueryParameters: Array<QueryParameter>,
  }
  // その他のプロパティについては、オンラインヘルプを参照してください。
}
type Field = {
  Name: string, // フィールド名
  // DataFieldまたはValueのいずれかを使用する必要があります。
  DataField?: string, // 連結フィールドに対するデータフィールド名
  Value?: string, // 計算フィールドに対するフィールド値
  /* 他のオプションプロパティ */
  // デフォルトの集計フィールド(使用可能な集計関数については、オンラインヘルプを参照してください。)
  Aggregate?: 'Count' | 'Sum' | 'Max' | 'Min' /* etc. */,
  // フィールドのデータ型
  DataType?: 'String' | 'Integer' | 'Float' | 'Number' | 'Boolean' | 'DateTime',
}
type QueryParameter = {
  Name: string, // パラメータ名
  Value: string, // パラメータ値
}

openDataSourceEditorImplオブジェクト

コードのコピー
/* オプション:データソースエディタを使用してデータソーのを追加、編集します。 */
var openDataSourceEditorImpl = function (options) {
        ARDataSourceEditor.open(makeOptions(options, {
                serverApi: {
                        testConnection: baseServerApi.testDataSourceConnection,
                },
        }));
};                        

CanEditDataSourceOptionsオブジェクト

コードのコピー
export type CanEditDataSourceOptions = {
        /** データソース */
        dataSource: DataSource;

        /** データソースのデータプロバイダ */
        dataProvider: string;
};

export type CanEditDataSetOptions = {
        /** データセット */
        dataSet: DataSet;

        /** データセットの親データソースのデータプロバイダ */
        dataProvider: string;
};                  

InitDataSetForDataSourceOptionsオブジェクト

コードのコピー
export type InitDataSetForDataSourceOptions = {
/** データソース */
dataSource: DataSource;

/** データソースのデータプロバイダ */
dataProvider: string;

/** 初期化されるデータセット名 */
dataSetName: string;
};    

GetDataSetPropertiesOptionsオブジェクト

コードのコピー
export type GetDataSetPropertiesOptions = {
        /** データセットの親データソースのデータプロバイダ */
        dataProvider: string;
};

export type DataSetProperty = 'name' | 'commandType' | 'query' | 'fields' | 'calculatedFields' | 'parameters' | 'filters'
| 'caseSensitivity' | 'collation' | 'kanatypeSensitivity' | 'widthSensitivity' | 'accentSensitivity';

GetDataSetSchemaOptionsオブジェクト

コードのコピー
export type GetDataSetSchemaOptions = {
        /** データセット */
        dataSet: DataSet;

        /** データセットの親データソース */
        dataSource: DataSource;
};

GetDataSetSchemaResponseオブジェクト

コードのコピー
export type GetDataSetSchemaResponse = {
        /** データセットのフィールド */
        fields: Array;

        /** データセットクエリパラメータ */
        parameters: Array;
};

OpenDataSourceEditorBaseOptionsオブジェクト

コードのコピー
export type OpenDataSourceEditorBaseOptions = {
        /** デザイナが決定されたロケール値 */
        locale: 'en' | 'ja' | 'zh';


        /** 既存のデータソースを編集する場合はnullではない。新しいデータソースを作成する場合は**null**。 */
        dataSource: DataSource | null;

        /** レポートで使用されたデータソース */
        reportDataSources: Array;


        /** データソースを正常に編集または作成したときのコールバック */
        onSuccess: (options: DataSourceEditorOnSuccessOptions) => void;

        /** データソースエディタを閉じる時のコールバック */
        onClose: () => void;
};

DataSourceEditorOnSuccessOptionsオブジェクト

コードのコピー
export type DataSourceEditorOnSuccessOptions = {
        /** 正常に作成または編集されたデータソース */
        dataSource: DataSource;
};

OpenDataSetPickerBaseOptionsオブジェクト

コードのコピー
export type OpenDataSetPickerBaseOptions = {
        /** デザイナが決定されたロケール値 */
        locale: 'en' | 'ja' | 'zh';

        /** モードがパネルレイアウトの場合、[データ]タブに[データセットの追加]ボタンが表示されます。 */
        mode: DataSetPickerMode;

        /** モードがパネルでない場合は、[データセットの追加]ボタンがこのIDを持つ要素に描画します。 */
        elementId?: string;

        /** レポートのデータソース */
        reportDataSources: Array;

        /** レポートのデータセット */
        reportDataSets: Array;

        /** 追加するデータソースとデータセットは、この関数にパラメータとして渡します。 */
        addDataSourcesAndDataSets: (options: AddDataSourcesAndDataSetsOptions) => void;

        /** [データセットの追加]を閉じる時のコールバック。 */
        onClose: () => void;
};

DataSetPickerModeオブジェクト

コードのコピー
export type DataSetPickerMode = 'Panel' | 'Dialog';

AddDataSourcesAndDataSetsOptionsオブジェクト

コードのコピー
export type AddDataSourcesAndDataSetsOptions = {
        /** 追加するデータソース */
        dataSources: Array;

        /** 追加するデータセット */
        dataSets: Array;
};

CanAddDataSetForDataSourceOptionsオブジェクト

コードのコピー
export type CanAddDataSetForDataSourceOptions = {
        /** データソース */
        dataSource: DataSource;

        /** データソースのデータプロバイダ */
        dataProvider: string;
};                

DataSourceEditorApiオブジェクト

コードのコピー
                   /**
 * **ar-datasource-editor.js**モジュールによってエクスポートされた**ARDataSourceEditor**オブジェクトのタイプ。
 */
export type DataSourceEditorApi = {
        /* 指定した**DataSourceEditorInitOptions**オブジェクトを使用してデータソースエディタを初期化し、**「dataSourceEditorElementId」**属性を持つ<div>要素に描画します。
         * 
         * **例:**
         * ```javascript
         * ARDataSourceEditor.init('data-source-editor-id', dataSourceEditorInitOptions);
         * ```
         * 
         * @param dataSourceEditorElementId string
         * @param options DataSourceEditorInitOptions object
         */
        init: (dataSourceEditorElementId: string, options?: DataSourceEditorInitOptions) => void;

        /**
         * データソースエディタを開きます。
         * 
         * **Example:**
         * ```javascript
         * ARDataSourceEditor.open(dataSourceEditorOptions);
         * ```
         * 
         * @param options DataSourceEditorOptions object
         */
        open: (options: DataSourceEditorOptions) => void;
};

export type CustomProviderDescriptor = {
        /**
         * key:データプロバイダ識別子\
         * DataSource.ConnectionProperties.DataProviderプロパティに使用されます。
         */
        key: string;

        /**
         * name:データプロバイダーのラベル\
         * UIでデータプロバイダのラベルとして使用されます。
         */
        name: string;
};

export type DataSourceEditorInitOptions = {
        /** 定義済みデータプロバイダ */
        predefinedProviders?: Array;

        /** OleDBプロバイダ */
        oleDbProviders?: Array;

        /** カスタムプロバイダ */
        customProviders?: Array;
};

export type PredefinedProvider = 'SQL' | 'OLEDB' | 'ODBC' | 'JSON' | 'CSV' | 'XML';

export type OleDbProvider = PredefinedOleDbProvider | string;

export type PredefinedOleDbProvider = 'Microsoft.Jet.OLEDB.4.0' | 'SQLOLEDB.1' | 'MSDataShape.1' | 'MSDASQL.1';

export type DataSourceEditorOptions = OpenDataSourceEditorBaseOptions & {
        /** カスタムローカリゼーションデータを指定します。 */
        localeData?: Array;
                        

DataSourceEditorServerApiオブジェクト

コードのコピー
/** [データソースエディタ]のサーバーAPI */
        serverApi: {
                /**
                 * データソースへの接続をテストします。
                 * 
                 * @param options TestConnectionOptions object
                 */
                testConnection: (options: TestConnectionOptions) => Promise;
        };
};

export type TestConnectionOptions = {
        /** データソース */
        dataSource: DataSource;
};

export type TestConnectionResponse = {
        /** エラーコード: 成功した場合は0 */
        Code: number;

        /** 接続設定に利用可能なデータベースのリスト */
        Databases: Array | null,

        /** エラーメッセージ */
        Error: string | null,
};                

テーマ

getThemesList関数

パラメータ 戻り値の型 レスポンス
getThemesList() Promise Array<ThemesListItem>

ThemesListItemオブジェクト

コードのコピー
type ThemesListItem = {
  _id: string, // テーマのID
  Name: string, // テーマ名
  IsDefault: boolean, // デフォルトテーマとして設定するかどうかを指定します。1つのテーマのみをデフォルトとして設定できます。
  Dark1: string, //「濃色1」テーマ色
  Dark2: string, //「濃色2」テーマ色
  Light1: string, //「淡色1」テーマ色
  Light2: string, //「淡色2」テーマ色
  Accent1: string, //「アクセント1」テーマ色
  Accent2: string, //「アクセント2」テーマ色
  Accent3: string, //「アクセント3」テーマ色
  Accent4: string, //「アクセント4」テーマ色
  Accent5: string, //「アクセント5」テーマ色
  Accent6: string, //「アクセント6」テーマ色
  MajorFontFamily: string, // メジャーフォントファミリ
  MinorFontFamily: string, // マイナーフォントファミリ
}

getThemeContent関数

パラメータ 戻り値の型 レスポンス
getThemeContent(options: GetThemeContentOptions) Promise ThemeModel

GetThemeContentOptionsオブジェクト

コードのコピー
type GetThemeContentOptions = {
  id: string, // テーマのID
}

ThemeModelオブジェクト

コードのコピー
type ThemeModel = {
  Colors: {
    Dark1: string, //「濃色1」テーマ色
    Dark2: string, //「濃色2」テーマ色
    Light1: string, //「淡色1」テーマ色
    Light2: string, //「淡色2」テーマ色
    Accent1: string, //「アクセント1」テーマ色
    Accent2: string, //「アクセント2」テーマ色
    Accent3: string, //「アクセント3」テーマ色
    Accent4: string, //「アクセント4」テーマ色
    Accent5: string, //「アクセント5」テーマ色
    Accent6: string, //「アクセント6」テーマ色
    Hyperlink: string, // ハイパーリンク テキストのテーマ色
    HyperlinkFollowed: string, // 表示済みのハイパーリンク テキストのテーマ色
  },
  Fonts: {
    MajorFont: ThemeFont,
    MinorFont: ThemeFont,
  }
  Images: Array<ThemeImage>,
  Constants: Array<ThemeConstant>,
}
type ThemeFont = {
  Family: string, // フォントファミリ
  Style: string, // フォントのスタイル
  Size: string, // フォントのサイズ
  Weight: string, // フォントの太さ
}
type ThemeImage = {
  Name: string, // 画像の名前
  MIMEType: string, // 画像のMIMEタイプ
  ImageData: string, // Base64エンコード形式の画像データ
}
type ThemeConstant = {
  Key: string, // 定数キー
  Value: string, // 定数値
}

画像

getImagesList関数

パラメータ 戻り値の型 レスポンス
getImagesList() Promise Array<ImagesListItem>

ImagesListItemオブジェクト

コードのコピー
type ImagesListItem = {
  _id: string, // 画像のID
  Name: string, // 画像の名前
  MimeType: string, // 画像のMIMEタイプ
  Thumbnail: null, // 予約済み:「null」のみがサポートされています。
}

getImageUrl関数

デザイン時に外部画像を表示します。

パラメータ 戻り値の型
getImageUrl(options: GetImageUrlOptions) imageUrl: string

GetImageUrlOptionsオブジェクト

コードのコピー
type GetImageUrlOptions = {
  id: string, // 画像のID
}

レポートテンプレート

getTemplatesList関数

FileViewのようなカスタムコンポーネントを実装するために使用できます。

パラメータ 戻り値の型 レスポンス
getTemplatesList() Promise Array<TemplatesListItem>

TemplatesListItemオブジェクト

コードのコピー
type TemplatesListItem = {
  _id: string, // テンプレートID
  Name: string, // テンプレート名
}

getTemplateContent関数

パラメータ 戻り値の型 レスポンス
getTemplateContent(options: GetTemplateContentOptions) Promise レポートJSONモデル

GetTemplateContentOptionsオブジェクト

コードのコピー
type GetTemplateContentOptions = {
  id: string, // テンプレートID
}

getTemplateThumbnail関数

FileViewのようなカスタムコンポーネントを実装するために使用できます。

パラメータ 戻り値の型 レスポンス
getTemplateThumbnail(options: GetTemplateThumbnailOptions) Promise base64ImageData: string

GetTemplateThumbnailOptionsオブジェクト

コードのコピー
type GetTemplateThumbnailOptions = {
  id: string, // テンプレートID
}

その他

createResourceLink関数

RDLXレポート定義に格納するレポート、画像、テーマなどのリソースのリンクを作成します。リソースリンクは、レポートを描画する時に解決されます。レポートを正常にプレビューするためにこれらのリンクが正しく指定されている必要があります。

パラメータ 戻り値の型
createResourceLink(options: ResourceLinkOptions) resourceLink: string

ResourceLinkOptionsオブジェクト

コードのコピー
type ResourceLinkOptions = {
  id: string, // リソースID
  type: 'report' | 'image' | 'theme' | null, // リソースの種類
  version: null, // 予約済み:「null」のみがサポートされています。
}

parseResourceLink関数

createResourceLink関数の逆の操作を実装します。

パラメータ 戻り値の型
parseResourceLink(resourceLink: string) ResourceLinkOptions

updateRoute関数

新規または既存のレポートを編集するときにデザイナのURLを更新します。

パラメータ 戻り値の型
updateRoute(options: UpdateRouteOptions) void

UpdateRouteOptionsオブジェクト

コードのコピー
type UpdateRouteOptions = {
  id: string, // レポートのID
  version: null, // 予約済み:「null」のみがサポートされています。
}
関連トピック