- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Excel.IO
GC.Spread.Sheets.CellTypes.Base
クラス: Base
Hierarchy
Table of contents
コンストラクタ
プロパティ
メソッド
- activateEditor
- createEditorElement
- deactivateEditor
- focus
- format
- fromJSON
- getAutoFitHeight
- getAutoFitWidth
- getEditorValue
- getHitInfo
- isEditingValueChanged
- isImeAware
- isReservedKey
- paint
- paintContent
- parse
- processKeyDown
- processKeyUp
- processMouseDown
- processMouseEnter
- processMouseLeave
- processMouseMove
- processMouseUp
- selectAll
- setEditorValue
- toJSON
- updateEditor
- updateEditorContainer
- updateImeMode
コンストラクタ
constructor
• new Base()
他のセル型クラスの基本クラスを表します。
実例
// カスタムセル型を定義します。
function MyCellType(color) {
GC.Spread.Sheets.CellTypes.Base.apply(this, arguments);
this.color = color || "orange";
this.typeName = "MyCellType";
}
MyCellType.prototype = new GC.Spread.Sheets.CellTypes.Base();
MyCellType.prototype.paint = function (ctx, value, x, y, width, height, style, context) {
var MARGIN = 5,
plotLeft = x + MARGIN,
plotWidth = width - 2 * MARGIN,
plotTop = y + MARGIN,
plotHeight = height - 2 * MARGIN,
halfHeight = plotHeight / 2,
halfWidth = plotWidth / 2;
ctx.beginPath();
ctx.moveTo(plotLeft, plotTop + halfHeight);
ctx.lineTo(plotLeft + halfWidth, plotTop);
ctx.lineTo(plotLeft + plotWidth, plotTop + halfHeight);
ctx.lineTo(plotLeft + halfWidth, plotTop + plotHeight);
ctx.lineTo(plotLeft, plotTop + halfHeight);
ctx.strokeStyle = this.color;
ctx.stroke();
};
// カスタムセル型をセルに設定します。
sheet.setCellType(0, 0, new MyCellType("green"));
プロパティ
typeName
• typeName: string
シリアル化のサポートに使用される型名の文字列を表します。
メソッド
activateEditor
▸ activateEditor(editorContext, cellStyle, cellRect, context?): void
エディタをアクティブにし、エディタのプロパティまたは属性の設定やイベントの連結などを行います。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
cellStyle |
Style |
セルの実際のスタイル。 |
cellRect |
Rect |
セルのレイアウト情報。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void
createEditorElement
▸ createEditorElement(context?): HTMLElement
DOM要素を作成して返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
HTMLElement
DOM要素を返します。
deactivateEditor
▸ deactivateEditor(editorContext, context?): void
エディタを非アクティブにします。エディタのイベントの連結解除などが行われます。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void
focus
▸ focus(editorContext, context?): void
エディタDOM要素にフォーカスを設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void
format
▸ format(value, format, formattedData?, context?): string
指定した書式を使用して値を文字列に書式設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value |
any |
書式設定するオブジェクト値。 |
format |
string | GeneralFormatter |
書式。 |
formattedData? |
FormattedData |
書式付きデータ。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
string
書式設定された文字列を返します。
fromJSON
▸ fromJSON(settings): void
指定したJSON文字列からオブジェクト状態をロードします。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
settings |
any |
逆シリアル化されたセル型のデータ。 |
戻り値
void
getAutoFitHeight
▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number
行の自動サイズ調整の処理に使用できるセルの高さを取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value |
any |
セルの値。 |
text |
string |
セルのテキスト。 |
cellStyle |
Style |
セルの実際の値。 |
zoomFactor |
number |
現在のシートのズーム率。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
number
行の自動サイズ調整の処理に使用できるセルの高さを返します。
getAutoFitWidth
▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number
列の自動サイズ調整の処理に使用できるセルの幅を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value |
any |
セルの値。 |
text |
string |
セルのテキスト。 |
cellStyle |
Style |
セルの実際の値。 |
zoomFactor |
number |
現在のシートのズーム率。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
number
列の自動サイズ調整の処理に使用できるセルの幅を返します。
getEditorValue
▸ getEditorValue(editorContext, context?): any
エディタの値を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
any
エディタの値を返します。
getHitInfo
▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo
セル型のヒット情報を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
x |
number |
キャンバスを基準とする現在のポインタ位置の<i>x</i>座標。 |
y |
number |
キャンバスを基準とする現在のポインタ位置の<i>y</i>座標。 |
cellStyle |
Style |
現在のセルの実際のスタイル。 |
cellRect |
Rect |
現在のセルのレイアウト情報。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
x、y、row、col、cellRect、sheetAreaの各パラメーターと、isReservedLocationを示す値を含むオブジェクトを返します。isReservedLocationは、ヒットテストが、セル型が処理しなければならない特別な領域に位置する場合はtrue、それ以外の場合はfalseになります。
isEditingValueChanged
▸ isEditingValueChanged(oldValue, newValue, context?): boolean
編集値が変更されたかどうか。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
oldValue |
any |
古い編集値。 |
newValue |
any |
新しい編集値。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
boolean
oldValueがnewValueと等しい場合はtrue、それ以外の場合はfalse。
isImeAware
▸ isImeAware(context?): boolean
このセル型がIMEを認識するかどうか。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
boolean
セル型がIMEを認識する場合はtrue、それ以外の場合はfalse。
isReservedKey
▸ isReservedKey(e, context?): boolean
セル型がキーボードイベントを自分で処理するかどうかを返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
e |
KeyboardEvent |
KeyboardEvent。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
boolean
セル型がキーボードイベントを自分で処理する場合はtrue、それ以外の場合はfalseを返します。
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
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
parse
▸ parse(text, formatStr, context?): any
指定した書式文字列を使用してテキストをオブジェクトに解析します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
text |
string |
解析するテキスト文字列。 |
formatStr |
string |
解析書式文字列。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
any
解析されたオブジェクト。
processKeyDown
▸ processKeyDown(event, context?): boolean
表示モードでキーダウンを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
event |
KeyboardEvent |
KeyboardEvent。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processKeyUp
▸ processKeyUp(event, context?): boolean
表示モードでキーアップを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
event |
KeyboardEvent |
KeyboardEvent。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processMouseDown
▸ processMouseDown(hitInfo): boolean
表示モードでマウスダウンを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processMouseEnter
▸ processMouseEnter(hitInfo): boolean
表示モードでマウスエンターを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processMouseLeave
▸ processMouseLeave(hitInfo): boolean
表示モードでマウスリーブを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processMouseMove
▸ processMouseMove(hitInfo): boolean
表示モードでマウスムーブを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
processMouseUp
▸ processMouseUp(hitInfo): boolean
表示モードでマウスアップを処理します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
hitInfo |
IHitTestCellTypeHitInfo |
getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。 |
戻り値
boolean
処理が成功した場合はtrue、それ以外の場合はfalseを返します。
selectAll
▸ selectAll(editorContext, context?): void
エディタDOM要素内のすべてのテキストを選択します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void
setEditorValue
▸ setEditorValue(editorContext, value, context?): void
エディタの値を設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
value |
any |
アクティブセルから返された値。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void
toJSON
▸ toJSON(): any
オブジェクト状態をJSON文字列に保存します。
戻り値
any
セル型データ。
updateEditor
▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect
エディタのサイズを更新します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
cellStyle |
Style |
セルの実際のスタイル。 |
cellRect |
Rect |
セルのレイアウト情報。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
セルラッパー要素の新しいサイズを返します。これには'width'と'height'の2つのプロパティが含まれます。
updateEditorContainer
▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void
セルラッパー要素のサイズを更新します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
editorBounds |
Rect |
セルラッパー要素の新しいサイズ。 |
cellStyle |
Style |
セルの実際のスタイル。 |
戻り値
void
updateImeMode
▸ updateImeMode(editorContext, imeMode, context?): void
エディタのIMEモードを更新します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
editorContext |
HTMLElement |
createEditorElementメソッドによって作成されたDOM要素。 |
imeMode |
ImeMode |
セルの実際のスタイルからのIMEモード。 |
context? |
any |
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。 |
戻り値
void