Ruby/ClibPDF

ClibPDF の ruby インタフェース

Module/Class Hierarchy

ClibPDF -+
         |
         +- ClibPDF::PDF
         |
         +- ClibPDF::PlotDomain -+
         |                       |
         |                       +- ClibPDF::TimePlotDomain
         |
         +- ClibPDF::Axis -------+
                                 |
                                 +- ClibPDF::TimeAxis

Module ClibPDF

定数

Module Functino

ClibPDF.escapeSpecialChars(instr)

Class ClibPDF::PDF

Class Methods

ClibPDF::PDF.open(pspdf, [nMaxPages, nMaxFonts, nMaxImages, nMaxAnnots, nMaxObjects]): PDF クラスを生成して返す。

Methods

初期化、終了、設定関係

ClibPDF::PDF#init(): PDF クラスを初期化する。(もしかして ClibPDF::PDF.open() の中に入れるべきか？)
ClibPDF::PDF#pageInit(pagenum, rot, mediaboxstr, cropboxstr): ページの初期化をする。 rot は用紙の向きを ClibPDF::PORTRAIT, ClibPDF::LANDSCAPE のいずれかで指定する。 mediaboxstr, mediaboxstr は用紙サイズを以下のいずれかで指定する。 ClibPDF::LETTER, ClibPDF::LEGAL, ClibPDF::A4, ClibPDF::B5, ClibPDF::C5, ClibPDF::DL, ClibPDF::EXECUTIVE, ClibPDF::COMM10, ClibPDF::MONARCH, ClibPDF::FILM35MM
ClibPDF::PDF#finalizeAll(): PDF に対する操作をを終了する。
ClibPDF::PDF#close(): PDF クラスを終了する。(いらないようにすべき？)
ClibPDF::PDF#setCurrentPage(page): カレントページを設定する。
ClibPDF::PDF#setGlobalDocumentLimits(nMaxPages, nMaxFonts, nMaxImages, nMaxAnnots, nMaxObjects): 各パラメータの最大値の設定。
ClibPDF::PDF#finalizePage(page): ページ page を終了する。
ClibPDF::PDF#enableCompression(cmpON): 圧縮するかどうかを ClibPDF::YES, ClibPDF::NO で指定する。
ClibPDF::PDF#setDefaultDomainUnit(defunit): 座標単位を設定する。 ClibPDF::PDF#pageInit() を呼ぶ前に呼ぶ必要がある。
ClibPDF::PDF#setOutputFilename(filename): PDF 出力ファイル名を指定する。 ClibPDF::PDF#init() と ClibPDF::PDF#pageInit() の間で呼ぶ必要がある。
ClibPDF::PDF#useContentMemStream(flag)
ClibPDF::PDF#setPageDuration(seconds): スライドショーしたときのページ表示時間(秒単位)を指定する。
ClibPDF::PDF#setPageTransition(type, duration, direction, HV, IO)

PDF 出力

ClibPDF::PDF#getBufferForPDF(length)
ClibPDF::PDF#savePDFmemoryStreamToFile(filename): PDF の内容をファイルに保存する。
ClibPDF::PDF#openPDFfileInViewer(pdffilepath): pdffilepath でした PDFファイルを PDFプレビューアで表示する。 pdffilepath に nil を指定した場合は、作成中の PDF を表示する。
ClibPDF::PDF#launchPreview(): 作成中の PDF を PDFプレビューアで表示する。

グラフィック/描画関係

ClibPDF::PDF#moveto(x, y)
ClibPDF::PDF#rawMoveto(x, y): カレントポイントを (x, y) に移動する。
ClibPDF::PDF#rmoveto(x, y)
ClibPDF::PDF#rawRmoveto(x, y): カレントポイントから相対的に (x, y) 離れたポイントに移動する。
ClibPDF::PDF#lineto(x, y)
ClibPDF::PDF#rawLineto(x, y): カレントポイントから (x, y) まで線を引く。
ClibPDF::PDF#rlineto(x, y)
ClibPDF::PDF#rawRlineto(x, y): カレントポイントから相対的に (x, y) 離れたポイントまで線を引く。
ClibPDF::PDF#curveto(x1, y1, x2, y2, x3, y3)
ClibPDF::PDF#rawCurveto(x1, y1, x2, y2, x3, y3): カレントポイントから (x3, y3) までベジエ曲線を引く。
ClibPDF::PDF#rect(x, y, width, height)
ClibPDF::PDF#rawRect(x, y, width, height): 左下角の座標が (x, y) で幅 width、高さ height の長方形を描く。
ClibPDF::PDF#rectRotated(x, y, width, height, angle)
ClibPDF::PDF#rawRectRotated(x, y, width, height, angle): 左下角の座標が (x, y) で幅 width、高さ height 角度angle の長方形を描く。
ClibPDF::PDF#arc(x, y, r, sangle, eangle, moveto0)
ClibPDF::PDF#rawArc(x, y, r, sangle, eangle, moveto0): 中心座標 (x, y)、半径 r で開始角度 sangle、終了角度sangleの円弧を描く。 moveto0 に0以外を指定した場合は、
ClibPDF::PDF#quickCircle(xc, yc, r)
ClibPDF::PDF#rawQuickCircle(xc, yc, r): 中心座標 (xc, yc)、半径 r の円を描く。
ClibPDF::PDF#circle(x, y, r)
ClibPDF::PDF#rawCircle(x, y, r): 中心座標 (x, y)、半径 r の円を描く。
ClibPDF::PDF#newpath(): カレントパスとカレントポイントをクリアする。
ClibPDF::PDF#closepath(): カレントパスを閉じる。

グラフィック/path 関係

ClibPDF::PDF#clip()
ClibPDF::PDF#eoclip(): カレントパスをクリッピングの境界として設定する。
ClibPDF::PDF#fill()
ClibPDF::PDF#eofill(): 現在のパスで閉じられた平面を塗りつぶす。
ClibPDF::PDF#fillAndStroke()
ClibPDF::PDF#eofillAndStroke(): 現在のパスをを塗りつぶし、線も描く。
ClibPDF::PDF#stroke(): 現在のパスをを描く。

グラフィック/状態関係

ClibPDF::PDF#gsave()
ClibPDF::PDF#grestore(): 現在のグラフィック関係の状態をセーブ、リストアする。
ClibPDF::PDF#setdash(dashspec)
ClibPDF::PDF#nodash(): 破線のパタンを設定する。
ClibPDF::PDF#concat(a, b, c, d, e, f)
ClibPDF::PDF#rawConcat(a, b, c, d, e, f)
ClibPDF::PDF#rotate(angle): 座標系を回転する。
ClibPDF::PDF#scale(sx, xy): 座標系を拡大、縮小する。
ClibPDF::PDF#translate(x, y)
ClibPDF::PDF#rawTranslate(x, y): 座標原点をを (x, y) に設定する。

グラフィック/設定関係

ClibPDF::PDF#setlinewidth(width): 線の幅を width に設定する。
ClibPDF::PDF#setlinecap(cap): 線の端の描画方法を cap に設定する。cap として指定できるのは ClibPDF::CAP_BUTT, ClibPDF::CAP_ROUND, ClibPDF::CAP_SQUARE のいずれか。
ClibPDF::PDF#setlinejoin(join): 折れ線の角の描画方法を join に設定する。join として指定できるのは ClibPDF::JOIN_MITER, ClibPDF::JOIN_ROUND, ClibPDF::JOIN_BEVEL のいずれか。
ClibPDF::PDF#setflat(flat): flatness parameter を flat に設定する。
ClibPDF::PDF#setmiterlimit(limit): miter limit を limit に設定する。
ClibPDF::PDF#setstrokeadjust(flag): ？

グラフィック/色関係

ClibPDF::PDF#setgray(gray)
ClibPDF::PDF#setrgbcolor(r, g, b)
ClibPDF::PDF#setcmykcolor(c, m, y, k): stroke と fill color を設定する。
ClibPDF::PDF#setgrayFill(gray)
ClibPDF::PDF#setrgbcolorFill(r, g, b)
ClibPDF::PDF#setcmykcolorFill(c, m, y, k): fill color を設定する。
ClibPDF::PDF#setgrayStroke(gray)
ClibPDF::PDF#setrgbcolorStroke(r, g, b)
ClibPDF::PDF#setcmykcolorStroke(c, m, y, k): stroke color を設定する。

グラフィック/マーカー関係

ClibPDF::PDF#marker(x, y, type, size)
ClibPDF::PDF#rawMarker(x, y, type, size): 座標 (x, y) に種類 type、大きさ sizeのマーカーを描画する。
ClibPDF::PDF#pointer(x, y, direction, size)
ClibPDF::PDF#rawPointer(x, y, direction, size): 座標 (x, y) に種類 direction、大きさ sizeのポインタを描画する。
ClibPDF::PDF#errorbar(x, y1, y2, capsize)
ClibPDF::PDF#rawErrorbar(x, y1, y2, capsize): X座標 x に y1からy2までのエラーバーを引く。エラーバーの端点は大きさcapsizeで指定。
ClibPDF::PDF#highLowClose(x, vhigh, vlow, vclose, ticklen)
ClibPDF::PDF#rawHighLowClose(x, vhigh, vlow, vclose, ticklen)

フォント関係

ClibPDF::PDF#setFont(basefontname, encodename, size): フォントを設定する。
ClibPDF::PDF#setFontDirectories(pfmdir, pfbdir)
ClibPDF::PDF#setFontMapFile(mapfile)
ClibPDF::PDF#stringWidth(str): 文字列の長さをポイント(1/72インチ)で返す。
ClibPDF::PDF#capHeight()

テキスト関係

ClibPDF::PDF#beginText(clipmode)
ClibPDF::PDF#endText(): テキスト、フォント関係の操作の開始、終了。
ClibPDF::PDF#text(x, y, orientation, text)
ClibPDF::PDF#rawText(x, y, orientation, text): 座標 (x, y) に文字列 text を描画する。
ClibPDF::PDF#textAligned(x, y, orientation, centmode, text)
ClibPDF::PDF#rawTextAligned(x, y, orientation, centmode, text): 座標 (x, y) に文字列 text を描画する。
ClibPDF::PDF#textBox(xl, yl, width, height, angle, linespace, tbattr, text)
ClibPDF::PDF#rawTextBox(xl, yl, width, height, angle, linespace, tbattr, text): 座標 (xl, yl) に幅 width、高さ height、 linespaceのテキスト描画領域を作成し、文字列 text を描画する。
ClibPDF::PDF#textBoxFit(xl, yl, width, height, angle, inifontsize, fsdecrement, linespace, tbattr, text)
ClibPDF::PDF#rawTextBoxFit(xl, yl, width, height, angle, inifontsize, fsdecrement, linespace, tbattr, text): 座標 (xl, yl) に幅 width、高さ height、 linespaceのテキスト描画領域を作成し、文字列 text を描画する。
ClibPDF::PDF#setTextLeading(leading)
ClibPDF::PDF#setTextPosition(x, y)
ClibPDF::PDF#rawSetTextPosition(x, y): テキストカレントポイントを座標 (x, y) に設定する。
ClibPDF::PDF#textShow(text)
ClibPDF::PDF#textCRLFshow(text): カレントポイントに文字列 text を描画する。
ClibPDF::PDF#textCRLF(): テキストカレントポイントを次の行に移動する。

primitive PDF text operator functions

ClibPDF::PDF#setNextTextLineOffset(x, y)
ClibPDF::PDF#rawSetNextTextLineOffset(x, y)

テキスト/座標系関係

ClibPDF::PDF#setTextMatrix(a, b, c, d, x, y)
ClibPDF::PDF#concatTextMatrix(a, b, c, d, x, y)
ClibPDF::PDF#rotateText(degrees): 座標系を回転する。
ClibPDF::PDF#skewText(alpha, beta)
ClibPDF::PDF#setCharacterSpacing(spacing)
ClibPDF::PDF#setHorizontalScaling(scale)
ClibPDF::PDF#setWordSpacing(spacing)
ClibPDF::PDF#setTextRenderingMode(mode)
ClibPDF::PDF#setTextRise(rise)

イメージ関係

ClibPDF::PDF#importImage(filename, type, x, y, angle, flags)
ClibPDF::PDF#rawImportImage(filename, type, x, y, angle, flags): 画像タイプ type の画像ファイル filename を座標 (x, y) に角度 angle で描画する。
ClibPDF::PDF#placeInLineImage(imagedata, x, y, angle, width, height, pixwidth, pixheight, bitspercomp, CSorMask, gsave)
ClibPDF::PDF#rawPlaceInLineImage(imagedata, x, y, angle, width, height, pixwidth, pixheight, bitspercomp, CSorMask, gsave)

ハイパーテキスト・リンク関係

ClibPDF::PDF#setAnnotation(xll, yll, xur, yur, title, str, attr)
ClibPDF::PDF#rawSetAnnotation(xll, yll, xur, yur, title, str, attr): 左下 (xll, yll)、右上 (xur, yur) に文字列 title の annotation(注釈?) を挿入する。 annotation の属性は Array attr で指定する。
ClibPDF::PDF#includeTextFileAsAnnotation(xll, yll, xur, yur, title, filename, attr)
ClibPDF::PDF#rawIncludeTextFileAsAnnotation(xll, yll, xur, yur, title, filename, attr): 左下 (xll, yll)、右上 (xur, yur) に文字列 title のファイル filename から読み込んだ annotation(注釈?) を挿入する。 annotation の属性は Array attr で指定する。
ClibPDF::PDF#setActionURL(xll, yll, xur, yur, linkspec, attr)
ClibPDF::PDF#rawSetActionURL(xll, yll, xur, yur, linkspec, attr): 左下 (xll, yll)、右上 (xur, yur) に URL linkspec の annotation を挿入する。 annotation の属性は Array attr で指定する。使い方は examples/cover.rb を参照のこと。
ClibPDF::PDF#setLinkGoToPage(xll, yll, xur, yur, page, fitmode, attr)
ClibPDF::PDF#rawSetLinkGoToPage(xll, yll, xur, yur, page, fitmode, attr): 左下 (xll, yll)、右上 (xur, yur) にページ page への annotation(注釈?) を挿入する。 fitmode で view を指定する。 annotation の属性は Array attr で指定する。
ClibPDF::PDF#setLinkAction(xll, yll, xur, yur, action_dict, attr)
ClibPDF::PDF#rawSetLinkAction(xll, yll, xur, yur, action_dict, attr): 左下 (xll, yll)、右上 (xur, yur) に action_dict で指定した annotation(注釈?) を挿入する。 annotation の属性は Array attr で指定する。

ドキュメント属性

ClibPDF::PDF#setCreator(pname): ドキュメントの creator フィールドを設定する。
ClibPDF::PDF#setTitle(pname): ドキュメントの title フィールドを設定する。
ClibPDF::PDF#setSubject(pname): ドキュメントの subject フィールドを設定する。
ClibPDF::PDF#setKeywords(pname): ドキュメントの keywords フィールドを設定する。
ClibPDF::PDF#comments(pname): コメントを書く。
ClibPDF::PDF#setViewerPreferences(vP)
ClibPDF::PDF#setCompressionFilter(command, filterlist)

Page related public functions

ClibPDF::PDF#setPageSize(mboxstr, cboxstr)
ClibPDF::PDF#setBoundingBox(LLx, LLy, URx, URy)
ClibPDF::PDF#setMediaBox(LLx, LLy, URx, URy)
ClibPDF::PDF#setCropBox(LLx, LLy, URx, URy)

Class ClibPDF::PlotDomain

Class Methods

ClibPDF::PlotDomain.new(x, y, w, h, xL, xH, yL, yH, xtype, ytype, reserved)

Methods

ClibPDF::PlotDomain#freePlotDomain(): PlotDomain のインスタンスを破棄する。(いらないようにすべき？)
ClibPDF::PlotDomain#setPlotDomain(pdf, x, y)
ClibPDF::PDF#setPlotDomain(domain, x, y): ClibPDF::PlotDomain のインスタンスを ClibPDF::PDF に登録する。
ClibPDF::PlotDomain#clipDomain()
ClibPDF::PlotDomain#fillDomainWithGray(gray): 0 から 1 の範囲で PlotDomain の色を設定する。
ClibPDF::PlotDomain#fillDomainWithRGBcolor(r, g, b): PlotDomain のカラーを設定する。
ClibPDF::PlotDomain#setMeshColor(meshMajorR, meshMajorG, meshMajorB, meshMinorR, meshMinorG, meshMinorB): PlotDomain の grid/mesh のカラーを設定する。
ClibPDF::PlotDomain#drawMeshForDomain(): grid/mesh を描画する。
ClibPDF::PlotDomain#setLinearMeshParams(xy, mesh1ValMajor, intervalMajor, mesh1ValMinor, intervalMinor): PlotDomain の mesh の設定をする。

Class ClibPDF::TimePlotDomain

Super Class

ClibPDF::PlotDomain

Class Methods

ClibPDF::TimePlotDomain.new(x, y, w, h, xTL, xTH, yL, yH, xtype, ytype, reserved)

Class ClibPDF::Axis

Class Methods

ClibPDF::Axis.new(angle, length, type, valL, valH): type で指定された ClibPDF::LINEAR か ClibPDF::LOGARITHMIC に従って角度 angle 、長さ length の Axis(軸) クラスを生成して返す。 Axis の値の範囲は valL, valH で指定する。

Methods

ClibPDF::Axis#freeAxis(): Axis のインスタンスを破棄する。(いらないようにすべき？)
ClibPDF::Axis#drawAxis()
ClibPDF::Axis#attachAxisToDomain(domain, x, y)
ClibPDF::PlotDomain#attachAxisToDomain(anAx, x, y): ClibPDF::Axis のインスタンスを ClibPDF::PlotDomain に登録する。
ClibPDF::Axis#setAxisLineParams(axLineWidth, ticLenMaj, ticLenMin, tickWidMaj, tickWidMin): 軸の線幅や目盛の長さや線幅を設定する。
ClibPDF::Axis#setTicNumEnable(ticEnableMaj, ticEnableMin, numEnable): 主目盛、従目盛の表示をするかどうかと軸の目盛(数字)を表示するかを設定する。
ClibPDF::Axis#setAxisTicNumLabelPosition(ticPos, numPos, horizNum, horizLab): 目盛のマークや数字の軸線に対する場所を設定する。
ClibPDF::Axis#setAxisNumberFormat(format, fontName, fontSize): 軸に表示する数字のフォーマットやフォント名、フォントサイズを設定する。
ClibPDF::Axis#setTimeAxisNumberFormat(useMonName, use2DigYear, fontName, fontSize): 月や年の表示形式とフォント名やフォントサイズを設定する。 useMonName で月の表示に名前(Jan, Feb, Mar)を使うか数字を使うかを設定する。設定は ClibPDF::MONTH_NUMBER か ClibPDF::MONTH_NAME で行う。 use2DigYear で年の表示形式を設定する。設定は、ClibPDF::YEAR_FULL, ClibPDF::YEAR_4DIGIT, ClibPDF::YEAR_2DIGIT のいずれかで行う。 (ClibPDF::TimeAxisだけにして良い？)
ClibPDF::Axis#setAxisLabel(labelstring, fontName, encoding, fontSize): 軸の文字列とフォント名、フォントサイズを指定する。
ClibPDF::Axis#setLinearAxisParams(tic1ValMajor, intervalMajor, tic1ValMinor, intervalMinor): 主目盛の最小値、間隔や従目盛の最小値、間隔を設定する。
ClibPDF::Axis#setLogAxisTickSelector(ticselect): Logscale 時に表示する目盛の設定をする。 ticselect は以下のいずれかで指定する。 ClibPDF::LOGAXSEL_1, ClibPDF::LOGAXSEL_13, ClibPDF::LOGAXSEL_125, ClibPDF::LOGAXSEL_12468, ClibPDF::LOGAXSEL_12357, ClibPDF::LOGAXSEL_123456789, ClibPDF::LOGAXSEL_MIN, ClibPDF::LOGAXSEL_MAX
ClibPDF::Axis#setLogAxisNumberSelector(numselect): Logscale 時に表示する目盛の表示の設定をする。 numselect は以下のいずれかで指定する。 ClibPDF::LOGAXSEL_1, ClibPDF::LOGAXSEL_13, ClibPDF::LOGAXSEL_125, ClibPDF::LOGAXSEL_12468, ClibPDF::LOGAXSEL_12357, ClibPDF::LOGAXSEL_123456789, ClibPDF::LOGAXSEL_MIN, ClibPDF::LOGAXSEL_MAX

Class ClibPDF::TimeAxis

Class Methods

ClibPDF::TimeAxis.new(angle, length, type, vtl, vth): 時間軸を Axis クラスを生成して返す。

Super Class

ClibPDF::Axis