Options
All
  • Public
  • Public/Protected
  • All
Menu

Module f3js

f3.js全機能へアクセスするためのエントリポイントを提供するモジュール

Index

Variables

containers

containers: ContainerIface[] = null

作成された子コンテナの配列

matrix

matrix: Matrix2D

現在のページの変形(オフセット、回転、拡縮など)を表す変形行列を返す (Container.matrix)

rotation

rotation: number

現在のページの回転 (Container.rotation)

x

x: number

現在のページのX座標 (Container.x)

y

y: number

現在のページのY座標 (Container.y)

Functions

add

  • add(shape: ShapeIface | Module, x?: number | any, y?: number, rotation?: number): any
  • 現在のページに図形やモジュールを追加する (Container.add)

    Parameters

    • shape: ShapeIface | Module
    • Default value x: number | any = 0
    • Default value y: number = 0
    • Default value rotation: number = 0

    Returns any

addPage

  • addPage(): void
  • 新しいページを追加する

    • 以降の描画対象は追加されたページになる
    • ページの切り替えには usePage を使う

    (Add a new page and use it for rendering shapes.)

    Returns void

c

  • c(x: number, y: number, r: number): Circle
  • Shorthand for drawCircle.

    Parameters

    • x: number
    • y: number
    • r: number

    Returns Circle

cc

  • cc(): any

cp

  • cp(): any
  • Shorthand for createPath.

    Returns any

createContainer

  • createContainer(): any
  • 新しいコンテナを作る

    • 作成されたコンテナは自動的にこのページの子コンテナになる

    Returns any

    コンテナ

createPath

  • createPath(): any
  • 新しいパスを作る

    Returns any

    パス

drawCircle

  • drawCircle(x: number, y: number, r: number): Circle

drawJointLine

  • drawJointLine(x: number, y: number, ex: number, ey: number, width?: number, height?: number, hull?: boolean, straightFirst?: boolean, internal?: boolean): JointLine
  • 立体の面をなす線分を描く (Container.drawJointLine)

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number
    • Default value width: number = 3
    • Default value height: number = 2
    • Default value hull: boolean = true
    • Default value straightFirst: boolean = true
    • Default value internal: boolean = false

    Returns JointLine

drawJointRectangle

  • drawJointRectangle(x: number, y: number, w: number, h: number, width?: number, height?: number, hull?: boolean): JointRectangle
  • 立体の面をなす矩形を描く (Container.drawJointRectangle)

    Parameters

    • x: number
    • y: number
    • w: number
    • h: number
    • Default value width: number = 3
    • Default value height: number = 2
    • Default value hull: boolean = true

    Returns JointRectangle

drawLine

  • drawLine(x: number, y: number, ex: number, ey: number): Line
  • 線分を描く (Container.drawLine)

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number

    Returns Line

drawPinLine

  • drawPinLine(x: number, y: number, ex: number, ey: number, space?: number, r?: number): Line
  • ピンヘッダを挿せる穴の列を描く (Container.drawPinLine)

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number
    • Default value space: number = 2.54
    • Default value r: number = 0.4

    Returns Line

drawRectangle

  • drawRectangle(x: number, y: number, w: number, h: number): Rectangle

drawText

  • drawText(text: string, x: number, y: number): any
  • 文字を描く (Container.drawText)

    Parameters

    • text: string
    • x: number
    • y: number

    Returns any

getPageCount

  • getPageCount(): number
  • ページ数を返す

    • ページの追加には addPage を、切り替えには usePage を使う

    (Returns the page count.)

    Returns number

    ページ数 (page count)

isBrowser

  • isBrowser(): boolean
  • このコードがブラウザ上のインタプリタで実行されているか返す

    (Returns whether the code is currently running on the browser-based interpreter.)

    Returns boolean

    ブラウザ上ならtrue (True if the code is running on the browser)

jln

  • jln(x: number, y: number, ex: number, ey: number, width?: number, height?: number, hull?: boolean, straightFirst?: boolean, internal?: boolean): ShapeIface
  • Shorthand for drawJointLine.

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number
    • Default value width: number = 3
    • Default value height: number = 2
    • Default value hull: boolean = true
    • Default value straightFirst: boolean = true
    • Default value internal: boolean = false

    Returns ShapeIface

jrc

  • jrc(x: number, y: number, w: number, h: number, width?: number, height?: number, hull?: boolean): JointRectangle
  • Shorthand for drawJointRectangle.

    Parameters

    • x: number
    • y: number
    • w: number
    • h: number
    • Default value width: number = 3
    • Default value height: number = 2
    • Default value hull: boolean = true

    Returns JointRectangle

ln

  • ln(x: number, y: number, ex: number, ey: number): Line
  • Shorthand for drawLine.

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number

    Returns Line

pln

  • pln(x: number, y: number, ex: number, ey: number, space?: number, r?: number): PinLine
  • Shorthand for drawPinLine.

    Parameters

    • x: number
    • y: number
    • ex: number
    • ey: number
    • Default value space: number = 2.54
    • Default value r: number = 0.4

    Returns PinLine

rc

  • rc(x: number, y: number, w: number, h: number): Rectangle
  • Shorthand for drawRectangle.

    Parameters

    • x: number
    • y: number
    • w: number
    • h: number

    Returns Rectangle

remove

  • 現在のページから図形を削除する

    Parameters

    Returns ShapeIface

    削除された図形

removeAllChildren

  • removeAllChildren(): void
  • 現在のページをクリアして全ての図形を削除する

    Returns void

rotate

  • rotate(theta: number): void
  • 現在のページを回転する (Container.rotate)

    Parameters

    • theta: number

    Returns void

scale

  • scale(sx: number, sy: number): void
  • 現在のページを拡縮する (Container.scale)

    Parameters

    • sx: number
    • sy: number

    Returns void

skew

  • skew(skx: number, sky: number): void
  • 現在のページをゆがめる (Container.skew)

    Parameters

    • skx: number
    • sky: number

    Returns void

text

  • text(text: string, x: number, y: number): any
  • Shorthand for drawText.

    Parameters

    • text: string
    • x: number
    • y: number

    Returns any

translate

  • translate(dx: number, dy: number): void
  • 現在のページの描画開始位置(オフセット)をずらす (Container.translate)

    Parameters

    • dx: number
    • dy: number

    Returns void

usePage

  • usePage(index: number): void
  • 描画対象のページを切り替える

    • ページの追加には addPage を使う

    (Use the page with the specified index for rendering shapes.)

    Parameters

    • index: number

    Returns void

Generated using TypeDoc