JsDoc:

Overview

SVG の動的生成を補助するライブラリです。

source: svgcanvas.js

SVGCanvas(width, height)

svg 要素を管理します。

parameters

Number	width	幅
Number	height	高さ

methods

initialise(width, height)

appendTo(x)

removeFrom(x)

add(x)

remove(x)

properties

element svg

Number width

Number height

SVGElement(width, height)

SVG の各種子要素を管理します。

parameters

Number	width	幅
Number	height	高さ

methods

initialise(name, layer, stroke, fill)

getAttribute(name)

setAttribute(name, value)

properties

String id

String strokeColor

Number strokeWidth

Number strokeOpacity

String fillColor

Number fillOpacity

element element

String name

SVGAnchor(href, id)

SVG のa 要素を管理します。

parameters

String	href	URI
String	id	ID

methods

initialise(href, id)

add(x)

remove(x)

properties

element element

String id

SVGLayer(id)

SVG の g 要素を管理します。

parameters

String

id

ID

methods

initialise(id)

arrayToPoints(x)

add(x)

remove(x)

rect(x, y, width, height)

circle(cx, cy, r)

ellipse(cx, cy, rx, ry)

line(x1, y1, x2, y2)

polyline(points)

polygon(points)

text(str, x, y)

image(src, x, y, width, height)

properties

element element

String id

SVGDefinitions()

SVG の defs 要素を管理します。

methods

initialise()

add(x)

remove(x)

properties

element element

SVGFilter(id, x, y, width, height)

SVG の filter 要素を管理します。

parameters

String	id	ID
Number	x	X 座標
Number	y	Y 座標
Number	width	幅
Number	height	高さ

methods

initialise(id, x, y, width, height)

add(x)

remove(x)

properties

element element

String id

Number x

Number y

Number width

Number height

SVGFilterPrimitives.GaussianBlur(stdDeviation, x, y, input, result)

SVG の feGaussianBlur 要素を管理します。

parameters

Number	stdDeviation	標準偏差
String	x?	X 座標
String	y?	Y 座標
String	input?	入力
String	result?	出力

methods

initialise(stdDeviation, x, y, input, result)

properties

element element

SVGCanvas.initialise(width, height)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

	width
	height

SVGCanvas.appendTo(x)

指定された要素に子要素として追加します。

parameters

element

x

親要素

SVGCanvas.removeFrom(x)

指定された要素から削除します。

parameters

element

x

親要素

SVGCanvas.add(x)

子要素を追加します。

parameters

Object

x

親要素

SVGCanvas.remove(x)

子要素を削除します。

parameters

Object

x

親要素

SVGElement.initialise(name, layer, stroke, fill)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

	name
	layer
	stroke
	fill

SVGElement.getAttribute(name)

属性の値を取得します。

parameters

String

name

属性名

returns

undefined

値

SVGElement.setAttribute(name, value)

属性に値を設定します。

parameters

String	name	属性名
undefined	value	値

SVGAnchor.initialise(href, id)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

	href
	id

SVGAnchor.add(x)

要素を追加します。

parameters

Object

x

要素

SVGAnchor.remove(x)

要素を削除します。

parameters

Object

x

要素

SVGLayer.initialise(id)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

id

SVGLayer.arrayToPoints(x)

配列からカンマ区切りの座標リストへ変換します。

parameters

Array

x

配列

returns

String

文字列

SVGLayer.add(x)

要素を追加します。

parameters

Object

x

要素

SVGLayer.remove(x)

要素を削除します。

parameters

Object

x

要素

SVGLayer.rect(x, y, width, height)

四角形を作成します。

parameters

Number	x	X 座標
Number	y	Y 座標
Number	width	幅
Number	height	高さ

returns

SVGElement

SVGElement オブジェクト

SVGLayer.circle(cx, cy, r)

円を作成します。

parameters

Number	cx	中心の X 座標
Number	cy	中心の Y 座標
Number	r	半径

returns

SVGElement

SVGElement オブジェクト

SVGLayer.ellipse(cx, cy, rx, ry)

楕円を作成します。

parameters

Number	cx	中心の X 座標
Number	cy	中心の Y 座標
Number	rx	X 軸方向の半径
Number	ry	Y 軸方向の半径

returns

SVGElement

SVGElement オブジェクト

SVGLayer.line(x1, y1, x2, y2)

直線を作成します。

parameters

Number	x1	始点の X 座標
Number	y1	始点の Y 座標
Number	x2	始点の X 座標
Number	y2	終点の Y 座標

returns

SVGElement

SVGElement オブジェクト

SVGLayer.polyline(points)

折れ線を作成します。

parameters

Array/String

points

座標のリスト

returns

SVGElement

SVGElement オブジェクト

SVGLayer.polygon(points)

多角形を作成します。

parameters

Array/String

points

座標のリスト

returns

SVGElement

SVGElement オブジェクト

SVGLayer.text(str, x, y)

文字列を作成します。

parameters

String	str	文字列
Number	x	X 座標
Number	y	Y 座標

returns

SVGElement

SVGElement オブジェクト

SVGLayer.image(src, x, y, width, height)

画像を作成します。

parameters

String	src	URI
Number	x	X 座標
Number	y	Y 座標
Number	width	幅
Number	height	高さ

returns

SVGElement

SVGElement オブジェクト

SVGDefinitions.initialise()

コンストラクタから自動的に呼ばれ、初期化処理を行います。

SVGDefinitions.add(x)

要素を追加します。

parameters

Object

x

要素

SVGDefinitions.remove(x)

要素を削除します。

parameters

Object

x

要素

SVGFilter.initialise(id, x, y, width, height)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

	id
	x
	y
	width
	height

SVGFilter.add(x)

要素を追加します。

parameters

Object

x

要素

SVGFilter.remove(x)

要素を削除します。

parameters

Object

x

要素

SVGFilterPrimitives.create(name, x, y, input, result)

原始フィルタを作成します。

parameters

String	name	フィルタ名
String	x?	X 座標
String	y?	Y 座標
String	input?	入力
String	result?	出力

SVGFilterPrimitives.GaussianBlur.initialise(stdDeviation, x, y, input, result)

コンストラクタから自動的に呼ばれ、初期化処理を行います。

parameters

	stdDeviation
	x
	y
	input
	result

element SVGCanvas.svg

svg 要素

Number SVGCanvas.width

幅

Number SVGCanvas.height

高さ

element SVGElement.element

要素

String SVGElement.name

要素名

element SVGAnchor.element

要素

String SVGAnchor.id

ID

element SVGLayer.element

要素

String SVGLayer.id

ID

element SVGDefinitions.element

要素

element SVGFilter.element

要素

String SVGFilter.id

ID

Number SVGFilter.x

X 座標

Number SVGFilter.y

Y 座標

Number SVGFilter.width

幅

Number SVGFilter.height

高さ

SVGFilterPrimitives

SVG の原始フィルタを提供します。

element SVGFilterPrimitives.GaussianBlur.element

要素