B.2 データプロバイダのJavaScript API

以下のデータプロバイダのAPIについて説明します。

PrimitiveDataProvider

プロパティ	データ型	説明
providerType	String	データプロバイダのタイプ「PrimitiveDataProvider」が設定されています。

■getDataメソッド

メソッド	getData()
説明	値を取得します。取得した値は参照用です。更新しないでください。

■setDataメソッド

メソッド	setData(value)
引数	value [Boolean、Number、またはString]	値
説明	値を設定します。各部品で更新不可となっているプロパティに対して、値を設定することはできません。エラー(RCF11002)になります。

■getDataTypeメソッド

メソッド	getDataType()
戻り値	Boolean、Number、Stringのどれか
説明	データ型を取得します。

ArrayDataProvider

プロパティ	データ型	説明
providerType	String	データプロバイダのタイプ「ArrayDataProvider」が設定されています。

■getDataメソッド

メソッド	getData()
説明	値を取得します。取得した値は参照用です。更新しないでください。

■setDataメソッド

メソッド	setData(value)
引数	value [Array]	値
説明	値を設定します。各部品で更新不可となっているプロパティに対して、値を設定することはできません。エラー(RCF11002)になります。

■getDataTypeメソッド

メソッド	getDataType()
戻り値	Array
説明	データ型を取得します。

■getDataProviderメソッド

メソッド	getDataProvider(path)
引数	path [String]	パス
説明	データプロバイダを取得します。

■addItemメソッド

メソッド	addItem(item)
引数	item [任意]	配列要素
説明	配列の最後に要素を追加します。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■getItemAtメソッド

メソッド	getItemAt(index)
引数	index [Number]	インデックス
説明	配列の要素を取得します。取得した値は参照用です。更新しないでください。

■getLengthメソッド

メソッド	getLength()
説明	配列の長さを取得します。

■insertItemAtメソッド

メソッド	insertItemAt(index, item)
引数	index [Number]	インデックス
	item [任意]	要素
説明	指定した位置に要素を挿入します。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■removeItemAtメソッド

メソッド	removeItemAt(index)
引数	index [Number]	インデックス
説明	指定した位置の要素を削除します。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■replaceItemAtメソッド

メソッド	replaceItemAt(index, item)
引数	index [Number]	インデックス
	item [任意]	要素
説明	指定した位置の要素を置き換えます。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■sortItemsメソッド

メソッド	sortItems(comparator)
引数	comparator [function]	比較関数(省略可)
説明	配列をソートします。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

DateDataProvider

プロパティ	データ型	説明
providerType	String	データプロバイダのタイプ「DateDataProvider」が設定されています。

■getDataメソッド

メソッド	getData()
説明	値を取得します。取得した値は参照用です。更新しないでください。

■setDataメソッド

メソッド	setData(value)
引数	value [Date]	値
説明	値を設定します。各部品で更新不可となっているプロパティに対して、値を設定することはできません。エラー(RCF11002)になります。

■getDataTypeメソッド

メソッド	getDataType()
戻り値	Date
説明	データ型を取得します。

■getTimeメソッド

メソッド	getTime()
説明	1970年1月1日午前0時からのミリ秒を取得します。

■setTimeメソッド

メソッド	setTime(time)
引数	time [number]	ミリ秒
説明	1970年1月1日午前0時からのミリ秒を設定します。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

ObjectDataProvider

プロパティ	データ型	説明
providerType	String	データプロバイダのタイプ「ObjectDataProvider」が設定されています。

■getDataメソッド

メソッド	getData()
説明	値を取得します。取得した値は参照用です。更新しないでください。

■setDataメソッド

メソッド	setData(value)
引数	value [Object]	値
説明	値を設定します。各部品で更新不可となっているプロパティに対して、値を設定することはできません。エラー(RCF11002)になります。

■getDataTypeメソッド

メソッド	getDataType()
戻り値	Object
説明	データ型を取得します。

■getDataProviderメソッド

メソッド	getDataProvider(path)
引数	path [String]	パス
説明	データプロバイダを取得します。

■getPropertyメソッド

メソッド	getProperty(name)
引数	name [String]	プロパティ名
説明	プロパティ値を取得します。取得した値は参照用です。更新しないでください。

■setPropertyメソッド

メソッド	setProperty(name, value)
引数	name [String]	プロパティ名
	value [任意]	値
説明	プロパティ値を設定します。存在していないプロパティに対して設定することはできません。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■addPropertyメソッド

メソッド	addProperty(name, value)
引数	name [String]	プロパティ名
	value [任意]	値
説明	プロパティ値を追加します。すでに存在しているプロパティに対して設定する場合は、setPropertyを利用してください。各部品で更新不可および部分更新不可となっているプロパティに対して、値を更新することはできません。エラー(RCF11010)になります。

■getPropertyNamesメソッド

メソッド	getPropertyNames()
説明	プロパティ名のリスト(配列)を取得します。

NullDataProvider

プロパティ	データ型	説明
providerType	String	データプロバイダのタイプ「NullDataProvider」が設定されています。

■getDataメソッド

メソッド	getData()
説明	値を取得します。取得した値は参照用です。更新しないでください。

■setDataメソッド

メソッド	setData(value)
引数	value [ObjectまたはDate]	値
説明	値を設定します。各部品で更新不可となっているプロパティに対して、値を設定することはできません。エラー(RCF11002)になります。

■getDataTypeメソッド

メソッド	getDataType()
戻り値	Object
説明	データ型を取得します。