GC.Spread.Sheets.CellTypes.CheckBoxList

クラス: CheckBoxList

Sheets.CellTypes.CheckBoxList

Hierarchy

Base

↳ CheckBoxList

コンストラクタ

constructor

プロパティ

typeName

メソッド

コンストラクタ

constructor

• new CheckBoxList()

編集可能なチェックボックスリスト型セルを表します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
activeSheet.getCell(2, 2).cellType(cellType2);

Overrides

Base.constructor

プロパティ

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

Inherited from

Base.typeName

メソッド

activateEditor

▸ activateEditor(editorContext, cellStyle, cellRect, context?): void

エディタをアクティブにし、エディタのプロパティまたは属性の設定やイベントの連結などを行います。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`cellStyle`	`Style`	セルの実際のスタイル。
`cellRect`	`Rect`	セルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.activateEditor

boxSize

▸ boxSize(value?): any

チェックボックスのサイズのテキストを取得または設定します。数値と「自動」のみをサポートします。不正な値を使用してもサイズは変わりません。

パラメータ

名前	型	説明
`value?`	`string` \| `number`	チェックボックスのサイズ。値が「auto」の場合、ラジオボタンのサイズはフォントサイズに応じて変化します。

戻り値

any

値が設定されていない場合は、チェックボックスのサイズを返します。それ以外の場合は、チェックボックスリスト型セルを返します。
// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.textAlign(20);
activeSheet.getCell(2, 2).cellType(cellType2);

createEditorElement

▸ createEditorElement(context?): HTMLElement

DOM要素を作成して返します。

パラメータ

名前	型	説明
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

HTMLElement

DOM要素を返します。

Inherited from

Base.createEditorElement

deactivateEditor

▸ deactivateEditor(editorContext, context?): void

エディタを非アクティブにします。エディタのイベントの連結解除などが行われます。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.deactivateEditor

direction

▸ direction(value?): any

チェックボックスリストの順序を取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.direction(GC.Spread.Sheets.CellTypes.Direction.vertical);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`value?`	`Direction`	順序が垂直方向かどうか。

戻り値

any

値が設定されていない場合、チェックボックスリストの順序が垂直かどうかを返します。それ以外の場合、チェックボックスリストのcellTypeを返します。

focus

▸ focus(editorContext, context?): void

エディタDOM要素にフォーカスを設定します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.focus

format

▸ format(value, format, formattedData?, context?): string

指定した書式を使用して値を文字列に書式設定します。

パラメータ

名前	型	説明
`value`	`any`	書式設定するオブジェクト値。
`format`	`string` \| `GeneralFormatter`	書式。
`formattedData?`	`FormattedData`	書式付きデータ。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

string

書式設定された文字列を返します。

Inherited from

Base.format

fromJSON

▸ fromJSON(settings): void

指定したJSON文字列からオブジェクト状態をロードします。

パラメータ

名前	型	説明
`settings`	`any`	逆シリアル化されたセル型のデータ。

戻り値

void

Inherited from

Base.fromJSON

getAutoFitHeight

▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number

行の自動サイズ調整の処理に使用できるセルの高さを取得します。

パラメータ

名前	型	説明
`value`	`any`	セルの値。
`text`	`string`	セルのテキスト。
`cellStyle`	`Style`	セルの実際の値。
`zoomFactor`	`number`	現在のシートのズーム率。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

number

行の自動サイズ調整の処理に使用できるセルの高さを返します。

Inherited from

Base.getAutoFitHeight

getAutoFitWidth

▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number

列の自動サイズ調整の処理に使用できるセルの幅を取得します。

パラメータ

名前	型	説明
`value`	`any`	セルの値。
`text`	`string`	セルのテキスト。
`cellStyle`	`Style`	セルの実際の値。
`zoomFactor`	`number`	現在のシートのズーム率。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

number

列の自動サイズ調整の処理に使用できるセルの幅を返します。

Inherited from

Base.getAutoFitWidth

getEditorValue

▸ getEditorValue(editorContext, context?): any

エディタの値を取得します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

any

エディタの値を返します。

Inherited from

Base.getEditorValue

getHitInfo

▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo

セル型のヒット情報を取得します。

パラメータ

名前	型	説明
`x`	`number`	キャンバスを基準とする現在のポインタ位置の<i>x</i>座標。
`y`	`number`	キャンバスを基準とする現在のポインタ位置の<i>y</i>座標。
`cellStyle`	`Style`	現在のセルの実際のスタイル。
`cellRect`	`Rect`	現在のセルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

IHitTestCellTypeHitInfo

x、y、row、col、cellRect、sheetAreaの各パラメーターと、isReservedLocationを示す値を含むオブジェクトを返します。isReservedLocationは、ヒットテストが、セル型が処理しなければならない特別な領域に位置する場合はtrue、それ以外の場合はfalseになります。

Inherited from

Base.getHitInfo

isEditingValueChanged

▸ isEditingValueChanged(oldValue, newValue, context?): boolean

編集値が変更されたかどうか。

パラメータ

名前	型	説明
`oldValue`	`any`	古い編集値。
`newValue`	`any`	新しい編集値。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

oldValueがnewValueと等しい場合はtrue、それ以外の場合はfalse。

Inherited from

Base.isEditingValueChanged

isFlowLayout

▸ isFlowLayout(value?): any

チェックボックスリストのレイアウトが自動調整されるかどうかを取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.isFlowLayout(true);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`value?`	`boolean`	レイアウトが自動調整されるかどうか。

戻り値

any

値が設定されていない場合、レイアウトが自動調整されるかどうかを返します。それ以外の場合、チェックボックスリストのcellTypeを返します。

isImeAware

▸ isImeAware(context?): boolean

このセル型がIMEを認識するかどうか。

パラメータ

名前	型	説明
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がIMEを認識する場合はtrue、それ以外の場合はfalse。

Inherited from

Base.isImeAware

isReservedKey

▸ isReservedKey(e, context?): boolean

セル型がキーボードイベントを自分で処理するかどうかを返します。

パラメータ

名前	型	説明
`e`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がキーボードイベントを自分で処理する場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.isReservedKey

itemSpacing

▸ itemSpacing(value?): any

チェックボックスリスト内の2つの項目間の間隔を取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.itemSpacing({
     horizontal:80,
     vertical:20
});

パラメータ

名前	型	説明
`value?`	`IItemSpacing`	チェックボックスリスト内の2つの項目の間の間隔。

戻り値

any

値が設定されていない場合、チェックボックスリスト内の2つの項目の間の間隔を返します。それ以外の場合、チェックボックスリストのcellTypeを返します。

items

▸ items(items?): any

チェックボックスリストの項目を取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`items?`	`string`[] \| `ICelltypeItemOption`[]	チェックボックスリストの項目。

戻り値

any

値が設定されていない場合、items配列を返します。それ以外の場合、チェックボックスリストのcellTypeを返します。

maxColumnCount

▸ maxColumnCount(value?): any

チェックボックスリストの列数の項目を取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.maxColumnCount(2);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`value?`	`number`	チェックボックスリストの列数。

戻り値

any

値が設定されていない場合は、列数を返します。値が設定されている場合は、チェックボックスのcellTypeを返します。

maxRowCount

▸ maxRowCount(value?): any

チェックボックスリストの行数の項目を取得または設定します。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.maxRowCount(2);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`value?`	`number`	チェックボックスリストの行数。

戻り値

any

値が設定されていない場合は、行数を返します。値が設定されている場合は、チェックボックスのcellTypeを返します。

paint

▸ paint(ctx, value, x, y, w, h, style, context?): void

キャンバスにセルを描画します。

パラメータ

名前	型	説明
`ctx`	`CanvasRenderingContext2D`	キャンバスの2次元コンテキスト。
`value`	`any`	セルの値。
`x`	`number`	キャンバスを基準とする<i>x</i>座標。
`y`	`number`	キャンバスを基準とする<i>y</i>座標。
`w`	`number`	セルの幅。
`h`	`number`	セルの高さ。
`style`	`Style`	セルの実際のスタイル。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.paint

paintContent

▸ paintContent(ctx, value, x, y, w, h, style, context?): void

キャンバスにセル内容領域を描画します。

パラメータ

名前	型	説明
`ctx`	`CanvasRenderingContext2D`	キャンバスの2次元コンテキスト。
`value`	`any`	セルの値。
`x`	`number`	キャンバスを基準とする<i>x</i>座標。
`y`	`number`	キャンバスを基準とする<i>y</i>座標。
`w`	`number`	セル内容領域の幅。
`h`	`number`	セル内容領域の高さ。
`style`	`Style`	セルの実際のスタイル。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.paintContent

parse

▸ parse(text, formatStr, context?): any

指定した書式文字列を使用してテキストをオブジェクトに解析します。

パラメータ

名前	型	説明
`text`	`string`	解析するテキスト文字列。
`formatStr`	`string`	解析書式文字列。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

any

解析されたオブジェクト。

Inherited from

Base.parse

processKeyDown

▸ processKeyDown(event, context?): boolean

表示モードでキーダウンを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processKeyDown

processKeyUp

▸ processKeyUp(event, context?): boolean

表示モードでキーアップを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processKeyUp

processMouseDown

▸ processMouseDown(hitInfo): boolean

表示モードでマウスダウンを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processMouseDown

processMouseEnter

▸ processMouseEnter(hitInfo): boolean

表示モードでマウスエンターを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processMouseEnter

processMouseLeave

▸ processMouseLeave(hitInfo): boolean

表示モードでマウスリーブを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processMouseLeave

processMouseMove

▸ processMouseMove(hitInfo): boolean

表示モードでマウスムーブを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processMouseMove

processMouseUp

▸ processMouseUp(hitInfo): boolean

表示モードでマウスアップを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合はtrue、それ以外の場合はfalseを返します。

Inherited from

Base.processMouseUp

selectAll

▸ selectAll(editorContext, context?): void

エディタDOM要素内のすべてのテキストを選択します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.selectAll

setEditorValue

▸ setEditorValue(editorContext, value, context?): void

エディタの値を設定します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`value`	`any`	アクティブセルから返された値。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.setEditorValue

textAlign

▸ textAlign(value?): any

チェックボックスの位置のテキストを取得または設定します。left とrightのみがサポートされます。

実例

// 次のサンプルコードは、チェックボックスリスト型セルを作成します。
var cellType2 = new GC.Spread.Sheets.CellTypes.CheckBoxList();
cellType2.items([{text:"a",value:1},{text:"b",value:2},{text:"c",value:3}]);
cellType2.textAlign(GC.Spread.Sheets.CellTypes.TextAlign.left);
activeSheet.getCell(2, 2).cellType(cellType2);

パラメータ

名前	型	説明
`value?`	`TextAlign`	チェックボックスの位置のテキスト。

戻り値

any

値が設定されていない場合は、チェックボックスの位置のテキストを返します。値が設定されている場合は、チェックボックスのcellTypeを返します。

toJSON

▸ toJSON(): any

オブジェクト状態をJSON文字列に保存します。

戻り値

any

セル型データ。

Inherited from

Base.toJSON

updateEditor

▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect

エディタのサイズを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`cellStyle`	`Style`	セルの実際のスタイル。
`cellRect`	`Rect`	セルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

Rect

セルラッパー要素の新しいサイズを返します。これには'width'と'height'の2つのプロパティが含まれます。

Inherited from

Base.updateEditor

updateEditorContainer

▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void

セルラッパー要素のサイズを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`editorBounds`	`Rect`	セルラッパー要素の新しいサイズ。
`cellStyle`	`Style`	セルの実際のスタイル。

戻り値

void

Inherited from

Base.updateEditorContainer

updateImeMode

▸ updateImeMode(editorContext, imeMode, context?): void

エディタのIMEモードを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`imeMode`	`ImeMode`	セルの実際のスタイルからのIMEモード。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

Inherited from

Base.updateImeMode

GC.Spread.Sheets.CellTypes.CheckBoxList

クラス: CheckBoxList

Hierarchy

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

Overrides

プロパティ

typeName

Inherited from

メソッド

activateEditor

パラメータ

戻り値

Inherited from

boxSize

パラメータ

戻り値

createEditorElement

パラメータ

戻り値

Inherited from

deactivateEditor

パラメータ

戻り値

Inherited from

direction

パラメータ

戻り値

focus

パラメータ

戻り値

Inherited from

format

パラメータ

戻り値

Inherited from

fromJSON

パラメータ

戻り値

Inherited from

getAutoFitHeight

パラメータ

戻り値

Inherited from

getAutoFitWidth

パラメータ

戻り値

Inherited from

getEditorValue

パラメータ

戻り値

Inherited from

getHitInfo

パラメータ

戻り値

Inherited from

isEditingValueChanged

パラメータ

戻り値

Inherited from

isFlowLayout

パラメータ

戻り値

isImeAware

パラメータ

戻り値

Inherited from

isReservedKey

パラメータ

戻り値

Inherited from

itemSpacing

パラメータ

戻り値

items

パラメータ