Ignite UI™ API ヘルプ

ig.OlapXmlaDataSource

igOlapXmlaDataSource コンポーネントは、JavaScript クライアントアプリケーションと msmdpump.dll HTTP データプロバイダーで構成された Microsoft® SQL Server Analysis Services (SSAS) サーバー間の通信を処理します。Microsoft SQL Server Analysis Services (MS SASS) のデータを簡単に取得できる方法を提供します。SSAS サーバーからデータを取得するために Multidimensional Expressions (MDX) や XML for Analysis (XMLA) に関する特別な知識は必要ありません。igOlapXmlaDataSource は、指定したコマンドに基づいて必要な MDX クエリを生成します。igOlapXmlaDataSource は、OLAP データを視覚化および対話が可能な 1 つ以上の Ignite UI ウィジェットと通常使用されます (igPivotView™ または igPivotGrid™)。

コードサンプル

<!doctype html>
<html>
<head>
    <!-- jQuery Core -->
    <script src="js/jquery.js" type="text/javascript"></script>
    <!-- jQuery UI -->
    <script src="js/jquery-ui.js" type="text/javascript"></script>
    <!-- Infragistics Combined Scripts -->
    <script src="js/infragistics.core.js" type="text/javascript"></script>
    <script src="js/infragistics.lob.js" type="text/javascript"></script>
    <script type="text/javascript">
        $.support.cors = true;                
        $(function () {
            var dataSource = new $.ig.OlapXmlaDataSource({
                serverUrl: "http://sampledata.infragistics.com/olap/msmdpump.dll",
                catalog: "Adventure Works DW Standard Edition",
                cube: "Adventure Works",
                rows: "[Date].[Calendar]",
                measures: "[Measures].[Customer Count], [Measures].[Internet Order Count]"
            });
             
            dataSource.initialize().done(function(metadataTree) {
                // do anything with dataSource once it's initialized
                // the result of the pre-loaded rows, columns, filters and measures is evaluated as part of initialization 
                var result = dataSource.result();
            });
        });            
    </script>
</head>
<body>
</body>
</html>    

options

タイプ:: object
デフォルト:: {}

プロパティとしてデータソース構成オプションを含む javascript オブジェクト。

catalog

タイプ:

string

デフォルト:

null

カタログ名。
columns

タイプ:

string

デフォルト:

null

コンマ (,) で区切られた階層名のリスト。データソースの列に階層ができます。
cube

タイプ:

string

デフォルト:

null

データソース内のキューブの名前。
discoverProperties

タイプ:

object

デフォルト:

null

追加のプロパティは各ディスカバー要求と送信されます。
オブジェクトはキー/値ストアとして保存されます。各プロパティ名はキーで、プロパティ値は値です。
enableResultCache

タイプ:

bool

デフォルト:

true

XMLA 結果オブジェクトのキャッシュを有効/無効にします。
executeProperties

タイプ:

object

デフォルト:

null

追加のプロパティは各実行要求と共に送信されます。
オブジェクトはキー/値ストアとして保存されます。各プロパティ名はキーで、プロパティ値は値です。
filters

タイプ:

string

デフォルト:

null

コンマ (,) で区切られた階層名のリスト。データソースのフィルターに階層ができます。
isRemote

タイプ:

bool

デフォルト:

false

データが XMLA リモートプロバイダーから適用されるかどうかを指定します。
mdxSettings

タイプ:

object

デフォルト:

{}
Optional="true" XMLA サーバーへの要求を処理する方法についての情報を含む javascript オブジェクト。
- addCalculatedMembersOnColumns
  
  タイプ:
  
  bool
  
  デフォルト:
  
  true
  
  Optional="true" COLUMNS 軸に対するメンバーのセットの式を AddCalculatedMembers MDX メソッドでラップするどうかを示す値。デフォルト値は true です。
- addCalculatedMembersOnRows
  
  タイプ:
  
  bool
  
  デフォルト:
  
  true
  
  Optional="true" ROWS 軸に対するメンバーのセットの式を AddCalculatedMembers MDX メソッドでラップするどうかを示す値。デフォルト値は true です。
- dimensionPropertiesOnColumns
  
  タイプ:
  
  array
  
  デフォルト:
  
  []
  
  要素タイプ:
  
  object
  
  Optional="true" COLUMNS 軸に適用される非コンテキスト機密メンバープロパティの名前を持つ文字列配列。デフォルトでは、CHILDREN_CARDINALITY および PARENT_UNIQUE_NAME プロパティは常に次元プロパティに適用されます。
- dimensionPropertiesOnRows
  
  タイプ:
  
  array
  
  デフォルト:
  
  []
  
  要素タイプ:
  
  object
  
  Optional="true" ROWS 軸に適用される非コンテキスト機密メンバープロパティの名前を持つ文字列配列。デフォルトでは、CHILDREN_CARDINALITY および PARENT_UNIQUE_NAME プロパティは常に次元プロパティに適用されます。
- nonEmptyOnColumns
  
  タイプ:
  
  bool
  
  デフォルト:
  
  true
  
  Optional="true" NON EMPTY 句が COLUMNS 軸にあるかどうかを示す値。デフォルト値は true です。
- nonEmptyOnRows
  
  タイプ:
  
  bool
  
  デフォルト:
  
  true
  
  Optional="true" NON EMPTY 句が ROWS 軸にあるかどうかを示す値。デフォルト値は true です。
measureGroup

タイプ:

string

デフォルト:

null

データソース内のメジャーグループの名前。
measures

タイプ:

string

デフォルト:

null

コンマ (,) で区切られたメジャー名のリスト。データソースのメジャーになります。

requestOptions

タイプ:: object
デフォルト:: {}

XMLA サーバーへの要求を処理する方法についての情報を含むオブジェクト。

コードサンプル

// Initialize
$.ig.OlapXmlaDataSource({
    requestOptions: {
        // example for setting the credentials for basic authentication
        withCredentials: true,
        beforeSend: function (jqXHR, options, requestOptions) {
            var xhr = options.xhr();
            if (requestOptions.withCredentials && "withCredentials" in xhr) {
                // if the user name is "user123" and the passord is "password123" the value set for the
                // Authorization header will be "Basic dXNlcjEyMzpwYXNzd29yZDEyMw==" where "dXNlcjEyMzpwYXNzd29yZDEyMw=="
                // is the Base64 encoded string "user123:password123"
                jqXHR.setRequestHeader("Authorization", "Basic UserName:PasswordEncodedInBase64");
            }
        }
    }
});

beforeSend

タイプ:

function

デフォルト:

null

サーバーに要求が送信される直前に呼び出されるコールバック。jQuery.ajax の options オブジェクトの beforeSend コールバックを拡張します。
withCredentials

タイプ:

bool

デフォルト:

false

ユーザーエージェントによってサポートされる場合、値は XmlHttpRequest.withCredentials に適用されます。
このプロパティを true に設定すると、IE8/IE9 が、XDomainRequest ではなく XmlHttpRequest を使用して認証済みの同一発信元要求を信頼されるドメインに対して実行できるように、
ユーザーに資格情報を入力するよう求めるプロンプトを出します。

rows

タイプ:

string

デフォルト:

null

コンマ (,) で区切られた階層名のリスト。データソースの行に階層ができます。
serverUrl

タイプ:

string

デフォルト:

null

Optional="false" XMLA サーバーの URL。

詳細の表示

addColumnItem

.addColumnItem( columnItem:object );
ピボットグリッドの列に階層を追加します。
- columnItem
- タイプ:object
- ピボットグリッド列に追加するための階層であるオブジェクトタイプ $.ig.Hierarchy。
addFilterItem

.addFilterItem( filterItem:object );
ピボットグリッドのフィルター軸に階層を追加します。
- filterItem
- タイプ:object
- 追加する階層であるタイプ $.ig.Hierarchy のオブジェクト。
addFilterMember

.addFilterMember( hierarchyUniqueName:string, memberUniqueName:string );
結果のフィルターメンバーのリストにメンバーを追加します。
特定の階層のメンバーがこのフィルターリストに追加される場合、このフィルターリストにあるメンバーのみは結果の階層にあります。
- hierarchyUniqueName
- タイプ:string
- このメンバーが属する階層の一意の名前。
- memberUniqueName
- タイプ:string
- 追加するメンバーの一意の名前。
addMeasureItem

.addMeasureItem( measureItem:object );
ピボットグリッドのメジャーにメジャーを追加します。
- measureItem
- タイプ:object
- 追加する階層であるタイプ $.ig.Measure のオブジェクト。
addRowItem

.addRowItem( rowItem:object );
ピボットグリッドの行に階層を追加します。
- rowItem
- タイプ:object
- ピボットグリッド行に追加するための階層であるオブジェクトタイプ $.ig.Hierarchy。
catalog

.catalog( );

返却型:

object

返却型の説明:

現在のカタログである $.ig.Catalog タイプのオブジェクト。
データソース内の現在のカタログを取得します。
catalogs

.catalogs( );

返却型:

array

返却型の説明:

$.ig.Catalog オブジェクトの配列。
データソース内の現在読み込まれているカタログを取得します。
clearPendingChanges

.clearPendingChanges( );
最後に update() メソッドが呼び出された後のすべての保留中の変更をクリアします。
collapseTupleMember

.collapseTupleMember( axisName:string, tupleIndex:number, memberIndex:number );
次回 update() メソッドが呼び出されると、縮小されるタプルメンバーを設定します。
すでに縮小されるメンバーでこのメソッドを呼び出しても何もしません。
- axisName
- タイプ:string
- タプルの軸の名前。
- tupleIndex
- タイプ:number
- 軸のタプルのインデックス。
- memberIndex
- タイプ:number
- タプルのメンバーのインデックス。
columnAxis

.columnAxis( );

返却型:

array

返却型の説明:

$.ig.Hierarchy または $.ig.MeasureList タイプのオブジェクトの配列。
列軸の項目を返します。
cube

.cube( );

返却型:

object

返却型の説明:

現在のキューブである $.ig.Cube タイプのオブジェクト。
データソース内の現在のキューブを取得します。
cubes

.cubes( );

返却型:

array

返却型の説明:

$.ig.Cube オブジェクトの配列。
データソース内の現在読み込まれているキューブを取得します。
expandTupleMember

.expandTupleMember( axisName:string, tupleIndex:number, memberIndex:number );
次回 update() メソッドが呼び出されると、展開されるタプルメンバーを設定します。
すでに展開されるメンバーでこのメソッドを呼び出しても何もしません。
- axisName
- タイプ:string
- タプルの軸の名前。
- tupleIndex
- タイプ:number
- 軸のタプルのインデックス。
- memberIndex
- タイプ:number
- タプルのメンバーのインデックス。
filters

.filters( );

返却型:

array

返却型の説明:

$.ig.Hierarchy タイプのオブジェクトの配列。
フィルター軸の項目を返します。
getCoreElement

.getCoreElement( predicate:function, elementType:object );

返却型:

object

返却型の説明:

指定された型の $.ig.ICoreOlapElement、または null。
指定した述語と一致する指定した elementType の最初の要素を取得します。そのような要素が見つからない場合 null。
- predicate
- タイプ:function
- 指定したタイプの各コア要素に呼び出した述語コールバック。要素が検索条件と一致する場合 true を返します。そうでない場合は false。
- elementType
- タイプ:object
- $.ig.ICoreOlapElement.prototype.$type で指定されたオブジェクトは。プロトタイプが検証できる有効なタイプは、$.ig.Dimension、$.ig.Hierarchy、$.ig.Level、$.ig.Measure、$.ig.MeasureList です。
getCoreElements

.getCoreElements( predicate:function, elementType:object );

返却型:

object

返却型の説明:

指定したタイプの $.ig.ICoreOlapElement オブジェクトの配列、または空の配列。
指定した述語と一致する指定した elementType の要素のある配列を取得します。そのような要素が見つからない場合空の配列を取得します。
- predicate
- タイプ:function
- 指定したタイプの各コア要素に呼び出した述語コールバック。要素が検索条件と一致する場合 true を返します。そうでない場合は false。
- elementType
- タイプ:object
- $.ig.ICoreOlapElement.prototype.$type で指定されたオブジェクトは。プロトタイプが検証できる有効なタイプは、$.ig.Dimension、$.ig.Hierarchy、$.ig.Level、$.ig.Measure、$.ig.MeasureList です。
getDimension

.getDimension( dimensionUniqueName:string );

返却型:

object

返却型の説明:

$.ig.Dimension オブジェクトまたは null。
指定した一意の名前の $.ig.Dimension オブジェクトを返します。
- dimensionUniqueName
- タイプ:string
- 検索済みのディメンションオブジェクトの一意の名前。
getFilterMemberNames

.getFilterMemberNames( hierarchyUniqueName:string );

返却型:

array

返却型の説明:

文字列オブジェクトの配列。
特定の階層の選択したフィルターメンバーの一意名前を持つ文字列の配列を返します。
- hierarchyUniqueName
- タイプ:string
- アクティブなフィルターメンバーが返された階層の一意の名前。
getHierarchy

.getHierarchy( hierarchyUniqueName:string );

返却型:

object

返却型の説明:

$.ig.Hierarchy オブジェクトまたは null。
指定した一意の名前の $.ig.Hierarchy オブジェクトを返します。
- hierarchyUniqueName
- タイプ:string
- 検索済み階層オブジェクトの一意の名前。
getLevel

.getLevel( levelUniqueName:string );

返却型:

object

返却型の説明:

$.ig.Level オブジェクトまたは null。
指定した一意の名前の $.ig.Level オブジェクトを返します。
- levelUniqueName
- タイプ:string
- 検索済みレベルオブジェクト一意の名前。
getMeasure

.getMeasure( measureUniqueName:string );

返却型:

object

返却型の説明:

$.ig.Measure オブジェクトまたは null。
指定した一意の名前の$.ig.Measure オブジェクトを返します。
- measureUniqueName
- タイプ:string
- 検索済みメジャーオブジェクト一意の名前。
getMeasureList

.getMeasureList( );

返却型:

object

返却型の説明:

$.ig.MeasureList オブジェクトまたは null。
1 つ以上の $.ig.Measure object で処理する際に使用できる $.ig.MeasureList オブジェクトを返します。
getMembersOfHierarchy

.getMembersOfHierarchy( hierarchyUniqueName:string );
既定階層フィルターメンバーに選択された $.ig.OlapResultAxisMember オブジェクトの配列の提供完了時に Promise を返します。
- hierarchyUniqueName
- タイプ:string
- アクティブなフィルターメンバーが返された階層の一意の名前。
getMembersOfLevel

.getMembersOfLevel( levelUniqueName:string );
既定のレベルフィルターメンバーに選択された $.ig.OlapResultAxisMember オブジェクトの配列の提供完了時に Promise を返します。
- levelUniqueName
- タイプ:string
- アクティブなフィルターメンバーが返されたレベルの一意の名前。
getMembersOfMember

.getMembersOfMember( memberUniqueName:string );
現在のメンバーの子である $.ig.OlapResultAxisMember オブジェクトの配列の提供完了時に Promise を返します。
- memberUniqueName
- タイプ:string
- アクティブなフィルターメンバーが返されたメンバーの一意の名前。
initialize

.initialize( );
データソースをを初期化し、データソースが初期化されると解決される約束を返します。
期待される結果は、設定で指定された catalog/cube/measureGroup のメタデータツリーです。設定が有効なキューブ初期化データを提供しない場合、 null。
データソースが初期化されるまで有効になりません。isInitialized が false を返した場合、initialize() 以外すべてのメソッドはエラーを発生します。
isInitialized

.isInitialized( );

返却型:

bool

返却型の説明:

データソースが初期化された場合 true を返します。そうでない場合は false。
データソースの初期化状態を取得します。
isModified

.isModified( );

返却型:

bool

返却型の説明:

データソースは update() メソッドが呼び出したときまで変更された場合は true。それ以外の場合は false。
データソースが変更されるかどうかを示します。
isUpdating

.isUpdating( );

返却型:

bool

返却型の説明:

update() メソッドが実行中の場合は true。それ以外の場合は false。
update() メソッドの実行が処理中かどうかを示します。
measureGroup

.measureGroup( );

返却型:

object

返却型の説明:

現在のメジャーグループである $.ig.MeasureGroup タイプのオブジェクト。
データソース内の現在の measureGroup を取得します。
measureGroups

.measureGroups( );

返却型:

array

返却型の説明:

$.ig.MeasureGroup オブジェクトの配列。
データソース内の現在読み込まれているメジャーグループを取得します。
measures

.measures( );

返却型:

array

返却型の説明:

$.ig.Measure タイプのオブジェクトの配列。
メジャー軸の項目を返します。
metadataTree

.metadataTree( );

返却型:

object

返却型の説明:

メタデータツリーのルートノードである $.ig.OlapMetadataTreeItem タイプのオブジェクト。
完全に読み込まれたメタデータツリーを返します。
removeAllFilterMembers

.removeAllFilterMembers( hierarchyUniqueName:string );
フィルターメンバーのリストからすべてのメンバーを削除し、指定した階層のフィルターをクリアします。
- hierarchyUniqueName
- タイプ:string
- フィルターメンバーをクリアする階層の一意の名前。
removeColumnItem

.removeColumnItem( columnItem:object );
ピボットグリッドの列の階層またはメジャーリストを削除します。
- columnItem
- タイプ:object
- 解除する階層である $.ig.Hierarchy または $.ig.MeasureList タイプのオブジェクト。2 つ以上のメジャーが追加され、メジャーリストの位置が "columns" に設定された場合、メジャーリストになります。
removeFilterItem

.removeFilterItem( filterItem:object );
ピボットグリッドのフィルター軸から階層を削除します。
- filterItem
- タイプ:object
- 階層であるタイプ $.ig.Hierarchy のオブジェクトは削除されます。
removeFilterMember

.removeFilterMember( hierarchyUniqueName:string, memberUniqueName:string );
結果のフィルターメンバーのリストからメンバーを削除します。
- hierarchyUniqueName
- タイプ:string
- このメンバーが属する階層の一意の名前。
- memberUniqueName
- タイプ:string
- 削除するメンバーの一意の名前。
removeMeasureItem

.removeMeasureItem( measureItem:object );
ピボットグリッドのメジャーからメジャーを削除します。
- measureItem
- タイプ:object
- メジャーであるタイプ $.ig.Measure のオブジェクトは削除されます。
removeRowItem

.removeRowItem( rowItem:object );
ピボットグリッドの行の階層またはメジャーリストを削除します。
- rowItem
- タイプ:object
- タイプ $.ig.Hierarchy または $.ig.MeasureList のオブジェクトは、削除される階層です。または、1 つ以上のメジャーが追加された場合、メジャーリストの場所は "rows" に設定されます。
result

.result( );

返却型:

object

返却型の説明:

XMLA サービスから返された結果を表す $.ig.OlapResult タイプのオブジェクト。
最近の更新の結果を返します。最近の更新が失敗した場合は null。
rowAxis

.rowAxis( );

返却型:

array

返却型の説明:

$.ig.Hierarchy または $.ig.MeasureList タイプのオブジェクトの配列。
行軸の項目を返します。
setCatalog

.setCatalog( catalogName:string );
データソースの現在のカタログを設定し、cubes() および catalog() プロパティを更新します。
- catalogName
- タイプ:string
- カタログの名前。
setCube

.setCube( cubeName:string );
データソースの現在のキューブを設定し、cube()、measureGroup()、 metadataTree() properties プロパティを更新します。
- cubeName
- タイプ:string
- キューブの名前。
setMeasureGroup

.setMeasureGroup( measureGroupName:string );
データソースの現在のメジャーグループを設定し、measureGroup() および metadataTree() プロパティを更新します。
catalogs/cubes/measureGroups 項目はカスケード (キューブを読み込むためにカタログを設定する必要がある) されますが、メタデータツリーを構築するために、結果のメタデータをフィルターするメジャーグループの必要がありません。
setCube(cubeName) を呼び出した後、メタデータツリーを読み込んで、measureGroup() プロパティがデフォルトの「(すべて)」メジャーグループに設定されます。選択されているメジャーグループがないことを示します。
- measureGroupName
- タイプ:string
- メジャーグループの名前。
setMeasureListIndex

.setMeasureListIndex( index:number );
メジャーリストが行/列に配置されるインデックスを設定します。
- index
- タイプ:number
- メジャーリストが表示される位置のインデックス。
setMeasureListLocation

.setMeasureListLocation( location:object );
メジャーリストの位置を設定します。
- location
- タイプ:object
- 受け入れられる値は 'rows' と 'columns' です。
update

.update( );
保留の変更のリストで更新を実行し、データソース結果を更新します。

Ignite UI for jQuery | API リファレンス

ig.OlapXmlaDataSource

コード サンプル

関連サンプル

関連トピック

依存関係

コードサンプル