SpreadJS製品ヘルプ
format メソッド
GC.Spread.Sheets.CellTypes 名前空間 > Base クラス : format メソッド
書式設定するオブジェクト値。
書式。
書式付きデータ。
書式設定されたデータ配列。各アイテムは2つのプロパティ(typeとvalue)を持つオブジェクトです。これには、「number」、「text」、「fillingChar」、「placeholder」、「exponent」、「decimalSeparator」、「groupSeparator」、「numberPlaceholder」、「percent」、「permille」、および「currency」のタイプを含めることができます。 例:{type: 'number', value: '123'}。
条件付き書式の前景色。
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。
指定した書式を使用して値を文字列に書式設定します。
シンタックス
var instance = new GC.Spread.Sheets.CellTypes.Base();
var returnValue; // Type: string
returnValue = instance.format(value,
                              format,
                              formattedData,
                              formattedData.content,
                              formattedData.conditionalForeColor,
                              context);
function format( 
   value : Object,
   format : undefined,
   formattedData : Object,
   (optional) formattedData.content : Array,
   (optional) formattedData.conditionalForeColor : string,
   context : Object
) : string;

パラメータ

value
書式設定するオブジェクト値。
format
書式。
formattedData
書式付きデータ。
formattedData.content
書式設定されたデータ配列。各アイテムは2つのプロパティ(typeとvalue)を持つオブジェクトです。これには、「number」、「text」、「fillingChar」、「placeholder」、「exponent」、「decimalSeparator」、「groupSeparator」、「numberPlaceholder」、「percent」、「permille」、および「currency」のタイプを含めることができます。 例:{type: 'number', value: '123'}。
formattedData.conditionalForeColor
条件付き書式の前景色。
context
セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値の型

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

contextパラメーターには以下の項目を含めることができます。

項目 説明
context.sheet GC.Spread.Sheets.Sheetインスタンス 現在のシートを示します。
context.row number 行インデックス。
context.col number 列インデックス。
context.sheetArea GC.Spread.Sheets.SheetArea 現在のシート領域。

関連トピック

参照

Base クラス