javascriptリファレンス

CsStrImage

文字列イメージ(画像)を扱うオブジェクトです。

継承関係

・以下のオブジェクトを継承しており、関数とプロパティを使用することが出来ます。

CsBase
CsParam

プロパティ

width
幅 ※読み取り専用
height
高さ ※読み取り専用
drawing
描画中フラグ ※読み取り専用
テキストが描画中であればtrue、完了していればfalse

関数

CsStrImage( )
コンストラクタです。

書式 : CsStrImage ( )

戻り値
無し

create( width, height )
画像バッファの作成を行います

書式 : create ( width, height )

width
height
高さ
戻り値
無し

setPlane( plane )
描画先プレーンを設定します。

書式 : setPlane ( plane )

plane
プレーンオブジェクト
戻り値
無し

setText( text )
文章をセットします。
事前にセットされていた文章がある場合はクリア後にセットします。

書式 : setText ( text )

text
文字列
戻り値
無し

apendText( text )
文章を追加します。
事前にセットされていた文章がある場合はクリアせず追加します。

書式 : apendText ( text )

text
文字列
戻り値
無し

draw( )
文章の描画を行います。

書式 : draw ( )

戻り値
無し

setColor( rgb )
文字色の設定を行います。
※α値は無視されます。

書式 : setColor ( rgb )

rgb
カラー値(0x00RRGGBB)
戻り値
無し

setColor( r, g, b )
文字色の設定を行います。

書式 : setColor ( r, g, b )

r
赤成分(0-255)
g
緑成分(0-255)
b
青成分(0-255)
戻り値
無し

setShadowColor( rgb )
文字の影色の設定を行います。
※α値は無視されます。

書式 : setShadowColor ( rgb )

rgb
カラー値(0x00RRGGBB)
戻り値
無し

setShadowColor( r, g, b )
文字の影色の設定を行います。

書式 : setShadowColor ( r, g, b )

r
赤成分(0-255)
g
緑成分(0-255)
b
青成分(0-255)
戻り値
無し

setRubyColor( rgb )
文字のルビ色の設定を行います。
※α値は無視されます。

書式 : setRubyColor ( rgb )

rgb
カラー値(0x00RRGGBB)
戻り値
無し

setRubyColor( r, g, b )
文字のルビ色の設定を行います。

書式 : setRubyColor ( r, g, b )

r
赤成分(0-255)
g
緑成分(0-255)
b
青成分(0-255)
戻り値
無し

setFontSize( all )
文字サイズの設定を行います。

書式 : setFontSize ( all )

all
ss〜llまで全てのフォントサイズをallに設定します
戻り値
無し

setFontSize( ss, s, n, l ll )
文字サイズの設定を行います。

書式 : setFontSize ( ss, s, n, l ll )

ss
ssフォントサイズ
s
sフォントサイズ
n
nフォントサイズ
l
lフォントサイズ
ll
llフォントサイズ
戻り値
無し

setRubySize( size )
ルビサイズの設定を行います。

書式 : setRubySize ( size )

size
ルビサイズ
戻り値
無し

setMargin( left, top, right, bottom )
テキスト描画エリアのマージン設定を行います。

書式 : setMargin ( left, top, right, bottom )

left
左マージン
top
上マージン
right
右マージン
bottom
下マージン
戻り値
無し

setMove( h, v )
文字間の設定を行います。

書式 : setMove ( h, v )

h
横ピクセル数(default: 0)
v
縦ピクセル数(default: 0)
戻り値
無し

setRubyPos( pos )
ルビ位置の設定を行います。
文字の真上を0として左右への相対値を指定します。

書式 : setRubyPos ( pos )

pos
ルビ位置(default: 0)
戻り値
無し

setAdjustLineMode( mode )
1行内で複数の文字サイズがある場合の整列方法を設定します。
デフォルト設定は下ライン合わせになっています。

書式 : setAdjustLineMode ( mode )

mode
0:中央表示
1:上ライン合わせ
2:下ライン合わせ
戻り値
無し

enableEscape( enable )
エスケープシーケンスを許可するか設定します。

書式 : enableEscape ( enable )

enable
0:無効
1:有効
戻り値
無し

eraseEscape( erase )
エスケープシーケンスを消去してから表示するか設定します。

書式 : eraseEscape ( erase )

erase
0:消去しない
1:消去する
戻り値
無し

enableProh( enable )
禁則処理を有効にするか設定します。

書式 : enableProh ( enable )

enable
0:無効
1:有効
戻り値
無し

setCharFrame( speed )
文字スクロールスピードを設定します。

書式 : setCharFrame ( speed )

speed
スクロールスピード
戻り値
無し

enableNoFrameBlank( enable )
スペースの時に文字スクロールのフレーム待ちを行うか設定します。

書式 : enableNoFrameBlank ( enable )

enable
0:スペースも待つ
0:スペースは待たない
戻り値
無し

setProportional( prop )
可変幅フォントの時に可変幅で表示するか設定します。

書式 : setProportional ( prop )

prop
0:固定幅
0:可変幅
戻り値
無し

setFace( face )
フォントを設定します。

書式 : setFace ( face )

face
フォント名
戻り値
無し

setWeight( weight )
文字の太さを設定します。

書式 : setWeight ( weight )

weight
0:通常
1:太字
戻り値
無し

setShadow( around, rightdown )
影を表示するか設定します。

書式 : setShadow ( around, rightdown )

around
囲み設定 0:非表示 1:表示
rightdown
右下設定 0:非表示 1:表示
戻り値
無し