OpenOffice BasicにおけるChartModelは、チャート（グラフ）を操作するためのオブジェクトです。この記事では、その使い方をサンプルを交えてご紹介します。

プロパティの概要

com.sun.star.comp.chart2.ChartModelのプロパティ一覧を次に示す。

プロパティ		概要
SbxOBJECT/void	AddIn
SbxOBJECT/void	AdditionalShapes
SbxSTRING/void	BaseDiagram
SbxBOOL	DataSourceLabelsInFirstColumn
SbxBOOL	DataSourceLabelsInFirstRow
SbxBOOL	HasLegend	凡例を表示する指定
SbxBOOL	HasMainTitle	タイトルを表示する指定
SbxBOOL	HasSubTitle	サブタイトルを表示する指定
SbxBOOL	RefreshAddInAllowed
SbxSTRING	Location
SbxBOOL	Modified
SbxSTRING	ImplementationName
SbxARRAY	SupportedServiceNames
SbxSTRING	URL
SbxARRAY	Args
SbxOBJECT	CurrentController
SbxOBJECT	CurrentSelection
SbxOBJECT	FirstDiagram
SbxOBJECT	DataProvider
SbxOBJECT	ChartTypeManager
SbxOBJECT	PageBackground
SbxARRAY	UsedRangeRepresentations
SbxOBJECT	UsedData
SbxOBJECT	RangeHighlighter
SbxARRAY	Arguments
SbxOBJECT	TitleObject
SbxARRAY	AvailableServiceNames
SbxOBJECT	DocumentStorage
SbxOBJECT	NumberFormatSettings
SbxOBJECT	NumberFormats
SbxOBJECT	Parent
SbxARRAY	TransferDataFlavors
SbxOBJECT	UndoManager
SbxARRAY	Types
SbxARRAY	ImplementationId
SbxOBJECT	Title	グラフのタイトル
SbxOBJECT	SubTitle	グラフのサブタイトル
SbxOBJECT	Legend	グラフの凡例表示
SbxOBJECT	Area	グラフ背景の表示エリア
SbxOBJECT	Diagram	ダイアグラム
SbxOBJECT	Data
SbxOBJECT	DrawPage
SbxOBJECT	Delegator
SbxOBJECT	PropertySetInfo
SbxSTRING	PropertyToDefault
SbxARRAY	PropertiesToDefault
SbxSTRING	Dbg_SupportedInterfaces	サポートしているインタフェースの一覧
SbxSTRING	Dbg_Properties	属性の一覧
SbxSTRING	Dbg_Methods	メソッドの一覧

メソッドの概要

com.sun.star.comp.chart2.ChartModelのメソッド一覧を次に示す。

メソッド		概要
SbxEMPTY	queryInterface ( SbxOBJECT )
SbxVOID	addCloseListener ( SbxOBJECT )
SbxVOID	removeCloseListener ( SbxOBJECT )
SbxVOID	close ( SbxBOOL )
SbxBOOL	hasLocation ( void )
SbxSTRING	getLocation ( void )
SbxBOOL	isReadonly ( void )
SbxVOID	store ( void )
SbxVOID	storeAsURL ( SbxSTRING, SbxARRAY )
SbxVOID	storeToURL ( SbxSTRING, SbxARRAY )
SbxVOID	storeSelf ( SbxARRAY )
SbxVOID	addModifyListener ( SbxOBJECT )
SbxVOID	removeModifyListener ( SbxOBJECT )
SbxBOOL	isModified ( void )
SbxVOID	setModified ( SbxBOOL )
SbxSTRING	getImplementationName ( void )
SbxBOOL	supportsService ( SbxSTRING )
SbxARRAY	getSupportedServiceNames ( void )
SbxVOID	dispose ( void )
SbxVOID	addEventListener ( SbxOBJECT )
SbxVOID	removeEventListener ( SbxOBJECT )
SbxBOOL	attachResource ( SbxSTRING, SbxARRAY )
SbxSTRING	getURL ( void )
SbxARRAY	getArgs ( void )
SbxVOID	connectController ( SbxOBJECT )
SbxVOID	disconnectController ( SbxOBJECT )
SbxVOID	lockControllers ( void )	グラフの描画を抑制する
SbxVOID	unlockControllers ( void )	グラフの描画を再開する
SbxBOOL	hasControllersLocked ( void )
SbxOBJECT	getCurrentController ( void )
SbxVOID	setCurrentController ( SbxOBJECT )
SbxOBJECT	getCurrentSelection ( void )
SbxOBJECT	getFirstDiagram ( void )
SbxVOID	setFirstDiagram ( SbxOBJECT )
SbxVOID	createInternalDataProvider ( SbxBOOL )
SbxBOOL	hasInternalDataProvider ( void )
SbxOBJECT	getDataProvider ( void )
SbxVOID	setChartTypeManager ( SbxOBJECT )
SbxOBJECT	getChartTypeManager ( void )
SbxOBJECT	getPageBackground ( void )
SbxVOID	attachDataProvider ( SbxOBJECT )
SbxVOID	setArguments ( SbxARRAY )
SbxARRAY	getUsedRangeRepresentations ( void )
SbxOBJECT	getUsedData ( void )
SbxVOID	attachNumberFormatsSupplier ( SbxOBJECT )
SbxOBJECT	getRangeHighlighter ( void )
SbxOBJECT	getTitleObject ( void )
SbxVOID	setTitleObject ( SbxOBJECT )
SbxVOID	initNew ( void )
SbxVOID	load ( SbxARRAY )
SbxOBJECT	createClone ( void )
SbxVOID	setVisualAreaSize ( SbxINT64, SbxOBJECT )
SbxOBJECT	getVisualAreaSize ( SbxINT64 )
SbxOBJECT	getPreferredVisualRepresentation ( SbxINT64 )
SbxLONG	getMapUnit ( SbxINT64 )
SbxOBJECT	createInstance ( SbxSTRING )	ダイアグラムを作成する
SbxOBJECT	createInstanceWithArguments ( SbxSTRING, SbxARRAY )
SbxARRAY	getAvailableServiceNames ( void )
SbxVOID	loadFromStorage ( SbxOBJECT, SbxARRAY )
SbxVOID	storeToStorage ( SbxOBJECT, SbxARRAY )
SbxVOID	switchToStorage ( SbxOBJECT )
SbxOBJECT	getDocumentStorage ( void )
SbxVOID	addStorageChangeListener ( SbxOBJECT )
SbxVOID	removeStorageChangeListener ( SbxOBJECT )
SbxINT64	getSomething ( SbxARRAY )
SbxOBJECT	getNumberFormatSettings ( void )
SbxOBJECT	getNumberFormats ( void )
SbxOBJECT	getParent ( void )
SbxVOID	setParent ( SbxOBJECT )
SbxVOID	disposing ( SbxOBJECT )
SbxVOID	modified ( SbxOBJECT )
SbxEMPTY	getTransferData ( SbxOBJECT )
SbxARRAY	getTransferDataFlavors ( void )
SbxBOOL	isDataFlavorSupported ( SbxOBJECT )
SbxOBJECT	getUndoManager ( void )
SbxARRAY	getTypes ( void )
SbxARRAY	getImplementationId ( void )
SbxOBJECT	queryAdapter ( void )
SbxOBJECT	getTitle ( void )
SbxOBJECT	getSubTitle ( void )
SbxOBJECT	getLegend ( void )
SbxOBJECT	getArea ( void )
SbxOBJECT	getDiagram ( void )
SbxVOID	setDiagram ( SbxOBJECT )
SbxOBJECT	getData ( void )
SbxVOID	attachData ( SbxOBJECT )
SbxOBJECT	getDrawPage ( void )
SbxVOID	setDelegator ( SbxOBJECT )
SbxEMPTY	queryAggregation ( SbxOBJECT )
SbxOBJECT	getPropertySetInfo ( void )
SbxVOID	setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY	getPropertyValue ( SbxSTRING )
SbxVOID	addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID	removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID	addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID	removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT	getPropertySetInfo ( void )
SbxVOID	setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY	getPropertyValues ( SbxARRAY )
SbxVOID	addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID	removePropertiesChangeListener ( SbxOBJECT )
SbxVOID	firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG	getPropertyState ( SbxSTRING )
SbxARRAY	getPropertyStates ( SbxARRAY )
SbxVOID	setPropertyToDefault ( SbxSTRING )
SbxEMPTY	getPropertyDefault ( SbxSTRING )
SbxARRAY	getPropertyStates ( SbxARRAY )
SbxVOID	setAllPropertiesToDefault ( void )
SbxVOID	setPropertiesToDefault ( SbxARRAY )
SbxARRAY	getPropertyDefaults ( SbxARRAY )

プロパティの詳細

HasLegend

凡例を表示する指定。Boolean型の値がTrueなら凡例を表示する。Falseなら凡例を表示しない。

com.sun.star.comp.chart2.ChartModel オブジェクトのプロパティであるLegendは、凡例を表すオブジェクトです。凡例の有無はCharオブジェクトのHasLegendプロパティで設定します。デフォルトでHasLegendの値はTrue（凡例あり）になっています。グラフの凡例を表示しないようにする例を次に示します。

Chart.HasLegend = False

HasMainTitle

タイトル（題目）を表示する指定。Boolean型の値がTrueならタイトルを表示する。Falseならタイトルを表示しない。

グラフにタイトルを付ける例を次に示す。

Chart.HasMainTitle = True
Chart.Title.String = "メインタイトル"

HasSubTitle

サブタイトル（副題目）を表示する指定。Boolean型の値がTrueならサブタイトルを表示する。Falseならサブタイトルを表示しない。

グラフにサブタイトルを付ける例を次に示す。

Chart.HasSubTitle = True
Chart.SubTitle.String = "サブタイトル"

Title

グラフのタイトル（題目）に関する情報を集めたオブジェクト（com.sun.star.comp.chart.Titleサービスをサポート）。

SubTitle

グラフのサブタイトル（副題目）に関する情報を集めたオブジェクト（com.sun.star.comp.chart.Titleサービスをサポート）。

Legend

グラフの凡例表示に関する情報を集めたオブジェクト（com.sun.star.comp.chart.Legendサービスをサポート）。

Area

グラフ背景の表示エリア（com.sun.star.chart.Areaサービスをサポート）。

ここで言うグラフの背景（グラフエリア）とは、タイトルやサブタイトル、凡例などの表示位置も含めた、グラフ全体をカバーする領域である。

Diagram

ダイアグラムを表す。詳細は com.sun.star.comp.chart.Diagram 参照。

Dbg_Properties

このオブジェクトが持つプロパティの一覧（各プロパティがセミコロン記号で区切られた文字列）

Dbg_Methods

このオブジェクトが持つメソッドの一覧（各メソッドがセミコロン記号で区切られた文字列）

メソッドの詳細

lockControllers

グラフの描画を早くするため、描画の更新を抑制する。

引数

無し

戻り値

無し

使用例

oChart As Object

oChart = Charts.getByName("MyChart").embeddedObject
oChart.LockControllers

unlockControllers

描画の更新を再開する。

引数

無し

戻り値

無し

使用例

oChart As Object

oChart = Charts.getByName("MyChart").embeddedObject
oChart.UnLockControllers

getFirstDiagram

最初のダイアグラム・オブジェクトへの参照を返す

Function getFirstDiagram As Object

引数

無し

戻り値

最初のダイアグラム・オブジェクト（com.sun.star.comp.chart2.Diagram）への参照を返す

getDataProvider

データプロバイダ・オブジェクトへの参照を返す

Function getDataProvider As Object

引数

無し

戻り値

データプロバイダ・オブジェクト（ScChart2DataProvider）への参照を返す

createInstance

Function createInstance(name As String) As Object

ダイアグラムを作成する。

引数

name

グラフの種類

グラフの種類

種類	説明
com.sun.star.chart.BarDiagram	列
com.sun.star.chart.PieDiagram	扇
com.sun.star.chart.DonutDiagram	扇（ドーナツ）
com.sun.star.chart.AreaDiagram	表面
com.sun.star.chart.LineDiagram	線
com.sun.star.chart.XYDiagram	散布図
com.sun.star.chart.NetDiagram	レーダー網
com.sun.star.chart.StockDiagram	株価
com.sun.star.chart.StackableDiagram	積み上げグラフ

戻り値

作成したダイアグラム (com.sun.star.comp.chart.Diagram) への参照を返す。