18 スクリプト

目次

• 18.1 スクリプト言語の指定
  • 18.1.1 既定のスクリプト言語の指定
  • 18.1.2 スクリプト言語の局所宣言
• 18.2 script 要素
• 18.3 イベント処理
• 18.4 イベント属性
  • 18.4.1 SVGLoad イベントに対するイベント属性
  • 18.4.2 グラフィックス要素とコンテナ要素に対するイベント属性
  • 18.4.3 文書レベルイベント属性
  • 18.4.4 アニメーションイベント属性
• 18.5 DOM インタフェース
  • 18.5.1 インタフェース SVGScriptElement
  • 18.5.2 インタフェース SVGZoomEvent

18.1 スクリプト言語の指定

18.1.1 既定のスクリプト言語の指定

svg 要素の contentScriptType 属性は文書片において既定のものとなるスクリプト言語を指定する。 The ‘contentScriptType’ attribute on the ‘svg’ element specifies the default scripting language for the given document fragment.

18.1.2 スクリプト言語の局所宣言

各 script 要素ごとに個別にスクリプト言語を指定するには、 script 要素の type 属性に言語を指定する。 It is also possible to specify the scripting language for each individual ‘script’ element by specifying a ‘type’ on the ‘script’ element.

18.2 script 要素

script 要素は HTML の script 要素と同じであり、スクリプト（例えば ECMAScript ）の置き場を提供する。 script 要素内で定義される関数は現在の文書全体に渡り「大域的」なスコープを持つ。 A ‘script’ element is equivalent to the ‘script’ element in HTML and thus is the place for scripts (e.g., ECMAScript). Any functions defined within any ‘script’ element have a "global" scope across the entire current document.

下の Example script01 では関数 circle_click が定義されており、 circle 要素の onclick イベント属性から呼び出される。 下の図左は初期状態の画像である。 図右は円形をクリックした後の結果を示している。 Example script01 defines a function circle_click which is called by the ‘onclick’ event attribute on the ‘circle’ element. The drawing below on the left is the initial image. The drawing below on the right shows the result after clicking on the circle.

この例は説明目的で onclick イベント属性を利用しているに過ぎないことに注意。 例ではマウスと同じふるまいをする入力装置の存在を仮定しているが、常に存在しているとは限らない。 可能な限り広範な利用者をサポートするためには onclick イベント属性の代わりに onactivate イベント属性が用いられるべきである。 Note that this example demonstrates the use of the ‘onclick’ event attribute for explanatory purposes. The example presupposes the presence of an input device with the same behavioral characteristics as a mouse, which will not always be the case. To support the widest range of users, the ‘onactivate’ event attribute should be used instead of the ‘onclick’ event attribute.

script 要素の実行前には解決された type のメディア型の値が検査されなければならない。 SVG-UA がそのスクリプト言語をサポートしない場合、 script 要素は実行されてはならない。 Before attempting to execute the ‘script’ element the resolved media type value for ‘type’ must be inspected. If the SVG user agent does not support the scripting language then the ‘script’ element must not be executed.

<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" 
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="6cm" height="5cm" viewBox="0 0 600 500"
     xmlns="http://www.w3.org/2000/svg" version="1.1">
  <desc>Example script01 - onclick イベントからの ECMAScript 関数の呼び出し
  </desc>
  <!-- クリックごとに半径を変化させる ECMAScript -->
  <script type="application/ecmascript"> <![CDATA[
    function circle_click(evt) {
      var circle = evt.target;
      var currentRadius = circle.getAttribute("r");
      if (currentRadius == 100)
        circle.setAttribute("r", currentRadius*2);
      else
        circle.setAttribute("r", currentRadius*0.5);
    }
  ]]> </script>

  <!-- 描画領域の外形線を青色の線で描く -->
  <rect x="1" y="1" width="598" height="498" fill="none" stroke="blue"/>

  <!-- 各 click イベントごとに発動 -->
  <circle onclick="circle_click(evt)" cx="300" cy="225" r="100"
          fill="red"/>

  <text x="300" y="480" 
        font-family="Verdana" font-size="35" text-anchor="middle">

    Click on circle to change its size
  </text>
</svg>

Example script01

この例を SVG で表示（ SVG 対応ブラウザのみ）

18.3 イベント処理

次のいずれかが生じる時、イベントによりスクリプトが実行される： Events can cause scripts to execute when either of the following has occurred:

• 特定の要素の onclick や onload などの イベント属性 の値としてイベントが生じた時に実行されるスクリプトがあてがわれている。 Event attributes such as ‘onclick’ or ‘onload’ are assigned to particular elements, where the values of the event attributes are script which is executed when the given event occurs.
• DOM Level 2 Events [DOM2EVENTS] の イベントリスナ が定義されていて、オブジェクトにイベントが生じた時に誘発される。 Event listeners as described in DOM Level 2 Events [DOM2EVENTS] are defined which are invoked when a given event happens on a given object.

この仕様の関連する節： Related sections of the spec:

• UI イベント では、ポインタ移動イベント（例えばマウスの動き）や活性化イベント（例えばマウスクリック）などのイベントを SVG-UA がどう処理するかについて述べている。 User interface events describes how an SVG user agent handles events such as pointer movements events (e.g., mouse movement) and activation events (e.g., mouse click).
• DOM2 イベントとの関係 では、 DOM のどの部分が SVG でサポートされているかについてと、イベントリスナの登録の仕方について述べている。 Relationship with DOM2 events describes what parts of DOM are supported by SVG and how to register event listeners.

18.4 イベント属性

多くの SVG 要素で以下のイベント属性が利用できる。 The following event attributes are available on many SVG elements.

SVG 言語の一部としてのイベントの完全な一覧およびそれらのイベントに対する SVG DOM とその説明については サポートされるイベントの完全な一覧 を見よ。 The complete list of events that are part of the SVG language and SVG DOM and descriptions of those events is provided in Complete list of supported events.

18.4.1 SVGLoad イベントに対するイベント属性

以下に onload イベント属性の定義を示す。 イベント属性はすべての アニメーション要素 および、ほとんどの グラフィックス要素 と コンテナ要素 に指定できる。 onload イベント属性は グラフィカルイベント属性 と アニメーションイベント属性 のいずれにも分類される。 （要素に グラフィカルイベント属性 が指定可能かどうかについては各要素の定義を見よ。） Below is the definition for the ‘onload’ event attribute. It can be specified on all of the animation elements and most of the graphics elements and container elements. The ‘onload’ event attribute is classified as both a graphical event attribute and an animation event attribute. (See the definition for each element to determine whether it can have a graphical event attribute specified on it.)

18.4.2 グラフィックス要素とコンテナ要素に対するイベント属性

以下に グラフィカルイベント属性 の定義を示す。 これらはほとんどの グラフィックス要素 と コンテナ要素 に指定できる。 （要素に グラフィカルイベント属性 が指定可能かどうかについては各要素の定義を見よ。） Below are the definitions for the graphical event attributes. These can be specified on most graphics elements and container elements. (See the definition for each element to determine whether it can have a graphical event attribute specified on it.)

上に定義された onload は グラフィカルイベント属性 にも分類されることに注意。 Note that ‘onload’, defined above, is also classified as a graphical event attribute.

18.4.3 文書レベルイベント属性

以下に 文書イベント属性 の定義を示す。 これらは svg 要素にのみ指定できる。 Below are the definitions for the document event attributes. These can be specified only on ‘svg’ elements.

18.4.4 アニメーションイベント属性

以下に アニメーションイベント属性 の定義を示す。 これらは アニメーション要素 に指定できる。 Below are the definitions for the animation event attributes. These can be specified on the animation elements.

上に定義された onload は アニメーションイベント属性 にも分類されることに注意。 Note that ‘onload’, defined above, is also classified as an animation event attribute.

18.5 DOM インタフェース

18.5.1 インタフェース SVGScriptElement

SVGScriptElement インタフェースは script 要素に対応する。 The SVGScriptElement interface corresponds to the ‘script’ element.

interface SVGScriptElement : SVGElement,
                             SVGURIReference,
                             SVGExternalResourcesRequired {
  attribute DOMString type setraises(DOMException);
};

属性

type (DOMString)

与えられた script 要素の type 属性に対応する。 Corresponds to attribute ‘type’ on the given ‘script’ element.

設定時の例外

DOMException, code NO_MODIFICATION_ALLOWED_ERR

読み取り専用の属性 の変更を試みたときに投出される。 Raised on an attempt to change the value of a read only attribute.

18.5.2 インタフェース SVGZoomEvent

SVG ズームイベントセットが DOM 実装により実装されたかどうかの判定には、 DOMImplementation インタフェースの hasFeature を利用できる。 このイベントセットに対する特能文字列は "SVGZoomEvents" である。 この文字列は createEvent メソッドにも利用される。 A DOM consumer can use the hasFeature of the DOMImplementation interface to determine whether the SVG zoom event set has been implemented by a DOM implementation. The feature string for this event set is "SVGZoomEvents". This string is also used with the createEvent method.

zoom イベントハンドラはズームイベントの処理前に呼び出される。 DOM における他の部分は文書の以前の状態のままである。 文書はイベントハンドラが正常に終了したときに更新される。 The zoom event handler occurs before the zoom event is processed. The remainder of the DOM represents the previous state of the document. The document will be updated upon normal return from the event handler.

ズームイベントに対する UI イベント型は： The UI event type for a zoom event is:

SVGZoom

ズームイベントは, 利用者により SVG 文書片の現在の表示が等倍される際に生じる。 イベントハンドラは svg 要素においてのみ有効である。 SVGZoom イベント を見よ。 The zoom event occurs when the user initiates an action which causes the current view of the SVG document fragment to be rescaled. Event handlers are only recognized on ‘svg’ elements. See SVGZoom event.

• 浮上：無し Bubbles: Yes
• キャンセル：不可 Cancelable: No
• 文脈情報： zoomRectScreen, previousScale, previousTranslate, newScale, newTranslate, screenX, screenY, clientX, clientY, altKey, ctrlKey, shiftKey, metaKey, relatedNode
  （ screenX, screenY, clientX, clientY はズーム領域の中心を指示する。 clientX, clientY は対応する svg 要素のビューポートにおける座標である。 relatedNode は対応する svg 要素である。） Context Info: zoomRectScreen, previousScale, previousTranslate, newScale, newTranslate, screenX, screenY, clientX, clientY, altKey, ctrlKey, shiftKey, metaKey, relatedNode. (screenX, screenY, clientX and clientY indicate the center of the zoom area, with clientX and clientY in viewport coordinates for the corresponding ‘svg’ element. relatedNode is the corresponding ‘svg’ element.)

interface SVGZoomEvent : UIEvent {
  readonly attribute SVGRect zoomRectScreen;
  readonly attribute float previousScale;
  readonly attribute SVGPoint previousTranslate;
  readonly attribute float newScale;
  readonly attribute SVGPoint newTranslate;
};

属性

zoomRectScreen (readonly SVGRect)

スクリーン単位で指定されるズーム矩形。 The specified zoom rectangle in screen units.

SVGRect オブジェクトは読み取り専用である。 The SVGRect object is read only.

previousScale (readonly float)

ズーム操作が行われる前の前回のズーム操作後における倍率。 The scale factor from previous zoom operations that was in place before the zoom operation occurred.

previousTranslate (readonly SVGPoint)

ズーム操作が行われる前の前回のズーム操作後における並進量。 The translation values from previous zoom operations that were in place before the zoom operation occurred.

SVGPoint オブジェクトは読み取り専用である。 The SVGPoint object is read only.

newScale (readonly float)

ズーム操作が行われた後の倍率。 The scale factor that will be in place after the zoom operation has been processed.

newTranslate (readonly SVGPoint)

ズーム操作が行われた後の並進量。 The translation values that will be in place after the zoom operation has been processed.

SVGPoint オブジェクトは読み取り専用である。 The SVGPoint object is read only.