In order to access this site you need to enable JavaScript!

You are here: Reference > JavaScript > client-side > HTML DOM > objects > nodes and tags > ruby

ruby object

Browser support:

Designates an annotation or a pronunciation guide for words and phrases.

The only valid element within the ruby element is the rt element.

Syntax:

Methods that return the object:

•	document.createElement ("ruby")

If you want to see the HTML objects by categories, please visit this page.

HTML page for this element: ruby

Possible members:

Properties

Methods

Events

Style properties

accessKey

Sets or retrieves an access key to an element.

all

Represents a collection of all elements contained by an element or the entire document.

attributes

Represents a collection of attribute nodes that belong to an element.

behaviorUrns

Represents a collection of the Uniform Resource Names for all behaviors attached to an element.

canHaveChildren

Retrieves a Boolean value that indicates whether the element can contain child elements.

canHaveHTML

Retrieves a Boolean value that indicates whether the element can contain HTML formatted text.

childElementCount

9

Returns the number of element nodes that are direct descendants of the current element.

childNodes

Represents a collection of all nodes that are direct descendants of an element.

children

Represents a collection of all element nodes that are direct descendants of an element.

cite

Sets or retrieves the location of the source document.

className

Sets or retrieves the style class or classes that belong to the element.

clientHeight

Returns the height of the visible area for an object, in pixels. The value contains the height with the padding, but it does not include the scrollBar, border, and the margin.

clientLeft

Returns the width of the left border in pixels.

clientTop

Returns the height of the top border in pixels.

clientWidth

Returns the width of the visible area for an object, in pixels. The value contains the width with the padding, but does not include the scrollBar, border, and the margin.

contentEditable

Sets or retrieves whether the contents of the object are editable.

currentStyle

Represents the computed style settings for an element.

dateTime

Sets or retrieves the timestamp when a deletion or insertion was made.

dir

Sets or retrieves the text direction as related to the lang property.

disabled

Sets or retrieves the state of an object for user interaction.

filters

Represents a collection of all filter objects applied to an element.

firstChild

Returns a reference to the first child of the current element.

firstElementChild

9

Returns a reference to the first child element of the current element.

hideFocus

Specifies or returns whether a dotted rectangle (focus rectangle) is drawn around an object while it has focus.

Sets or retrieves a unique identifier for the object.

innerHTML

Sets or retrieves the inner HTML content (the source code between the opening and closing tags) of an element.

innerText

Sets or returns the text content of an element including the text content of its descendants.

isContentEditable

Returns a Boolean value that indicates whether the contents of the object are editable by the user.

isDisabled

Returns a Boolean value that indicates whether the object is disabled.

isMultiLine

Returns a Boolean value that indicates whether the contents of an element can be multiline or not.

isTextEdit

Returns a Boolean value that indicates whether the createTextRange method can be used for the element.

lang

Specifies or returns the language of the element.

language

Sets or retrieves the scripting language for the current element. Use it only for the script element.

lastChild

Returns a reference to the last child of the current element.

lastElementChild

9

Returns a reference to the last child element of the current element.

localName

9

Returns the local part of the qualified name of the current node.

namespaceURI

9

Sets or returns the namespace URI of the current node.

nextElementSibling

9

Returns a reference to the next child element of the current element's parent.

nextSibling

Returns a reference to the next child of the current element's parent.

nodeName

Returns the name of the current node.

nodeType

Returns an integer that indicates the type of the node.

nodeValue

Sets or returns the value of the current node.

offsetHeight

Returns the height of the visible area for an object, in pixels. The value contains the height with the padding, scrollBar, and the border, but does not include the margin.

offsetLeft

Returns the left position of an object relative to the left side of its offsetParent element, in pixels.

offsetParent

Returns a reference to the closest ancestor element in the DOM hierarchy from which the position of the current element is calculated.

offsetTop

Returns the top position of the object relative to the top side of its offsetParent element, in pixels.

offsetWidth

Returns the width of the visible area for an object, in pixels. The value contains the width with the padding, scrollBar, and the border, but does not include the margin.

outerHTML

Sets or retrieves the outer HTML content (the source code including the opening and closing tags) of an element.

outerText

Sets or returns the text content of an element including the text content of its descendants.

ownerDocument

Returns the document object that contains the current node.

parentElement

Returns the parent element of the object in the DOM hierarchy.

parentNode

Returns the parent element of the current node in the DOM hierarchy.

parentTextEdit

Returns the closest ancestor element of the current element in the DOM hierarchy that can be used to create a TextRange object.

previousElementSibling

9

Returns a reference to the previous child element of the current element's parent.

previousSibling

Returns a reference to the previous node of the current element's parent.

readyState

Returns a string value that represents the state of the object.

runtimeStyle

Represents the overridden style settings for an element.

scopeName

Retrieves the local name of the namespace declared for the current element.

scrollHeight

Returns the total height of an element's contents, in pixels. The value contains the height with the padding, but does not include the scrollBar, border, and the margin.

scrollLeft

Sets or retrieves the number of pixels by which the contents of an object are scrolled to the left.

scrollTop

Sets or retrieves the number of pixels by which the contents of an object are scrolled upward.

scrollWidth

Returns the total width of an element's contents, in pixels. The value contains the width with the padding, but does not include the scrollBar, border, and the margin.

sourceIndex

Returns the position of the current object in the all collection of the document.

style

Represents the inline style settings for an element or a CSS rule.

tabIndex

Specifies or returns the tabbing order for keyboard navigation using the TAB key.

tagName

Returns the tag name of the current element.

tagUrn

Sets or retrieves the Uniform Resource Name (URN) of the namespace declared for the current element.

textContent

9

Sets or returns the text content of an element including the text content of its descendants.

title

Specifies or returns a tooltip for an element.

uniqueID

Returns the unique identifier generated by the browser for the object.

unselectable

Sets or retrieves whether the selection process can start in an element's content.

addBehavior

Attaches the specified behavior to the current element.

addEventListener

9

Registers an event handler function (event listener) for the specified event on the current object.

appendChild

Inserts an element after the last child of the current element.

applyElement

Inserts the specified element as a child or parent of the current element.

attachEvent

Registers an event handler function (event listener) for the specified event on the current object.

blur

Removes the focus from the current element, and fires the onblur event.

clearAttributes

Clears all attributes from the current element, except the id, name, style, value and event attributes.

click

Simulates a mouse click on the current element.

cloneNode

Returns an exact copy of the current node.

compareDocumentPosition

9

Compares the placement of the specified node with the current node in the DOM hierarchy.

componentFromPoint

Returns the region of the current element that is located at the specified coordinates.

contains

Returns whether the specified element is a descendant of the current element.

detachEvent

Removes the specified event handler from the current element that was registered earlier with the attachEvent method.

dispatchEvent

9

Dispatches the specified event to the current element.

dragDrop

Initiates a drag-and-drop operation.

fireEvent

Initializes an event object and dispatches it to the current element.

focus

Sets the focus on the current element.

getAdjacentText

Returns the contents of the TextNode located at the specified position relative to the current element.

getAttribute

Returns the value of the attribute with the specified name from the current element.

getAttributeNode

Returns the attribute node with the specified name from the current element.

getAttributeNodeNS

9

Returns the attribute node with the specified namespace and name from the current element.

getAttributeNS

9

Returns the value of the attribute with the specified namespace and name from the current element.

getBoundingClientRect

Returns a TextRectangle object that specifies the bounding rectangle of the current element or TextRange object, in pixels, relative to the upper-left corner of the browser's client area.

getClientRects

Retrieves a TextRectangles collection that specifies the exact shape of the current element or TextRange object.

getElementsByClassName

9

Returns a NodeList collection that contains all descendant elements of the current element with the specified class name.

getElementsByTagName

Returns a NodeList collection that contains all descendant elements of the current element with the specified tag name.

getElementsByTagNameNS

9

Returns a NodeList collection that contains all descendant elements of the current element with the specified namespace URI and local name.

getExpression


9

Returns the dynamic expression for the specified DHTML property on the current element.

hasAttribute

8

Returns whether the current element has an attribute with the specified name or not.

hasAttributeNS

9

Returns whether the current element has an attribute with the specified namespace and name or not.

hasAttributes

8

Returns whether the current element has any attributes specified or not.

hasChildNodes

Returns whether the current node has any child nodes or not.

insertAdjacentElement

Inserts an element at the specified position relative to the current element.

insertAdjacentHTML

Inserts a HTML formatted text at the specified position relative to the current element.

insertAdjacentText

Creates a new TextNode from the specified text and inserts it at the specified position relative to the current element.

insertBefore

Inserts an element before the specified child of the current element.

isDefaultNamespace

9

Returns whether the specified namespace URI is the default namespace in the scope of the current node.

isEqualNode

9

Returns whether the current node is equal to the specified one.

isSameNode

9

Returns whether the current node is the same node as the specified one.

isSupported

9

Returns whether the specified DOM module and version is supported by the current node.

mergeAttributes

Copies all attributes and its values from the specified element to the current element.

normalize

Puts the subtree that belongs to the current node into a 'normalized' form.

querySelector

8

Returns a reference to the first descendant element of the current element, that matches the specified selectors.

querySelectorAll

8

Returns a NodeList collection that contains all descendant elements of the current element that match the specified selectors.

releaseCapture

Releases the mouse capture from the browser window that was previously set by the setCapture method and restores the normal event processing.

removeAttribute

Removes the attribute with the specified name from the current element.

removeAttributeNode

Removes the specified attribute node from the current element.

removeAttributeNS

9

Removes the attribute with the specified namespace and name from the current element.

removeBehavior

Removes the specified behavior from the current element.

removeChild

Removes the specified child node from the current element.

removeEventListener

9

Removes the specified event handler from the current element that was registered earlier with the addEventListener method.

removeExpression


9

Removes the dynamic expression from the specified DHTML property on the current element.

removeNode

Removes the current element with or without its children from the document tree.

replaceAdjacentText

Replace the contents of the TextNode located at the specified position relative to the current element with the specified text.

replaceChild

Replaces the specified child element of the current element with a new element.

replaceNode

Replaces the current element with the specified element.

scrollIntoView

Scrolls the specified element into the visible area of the document.

setActive

Sets the element as the active element in the current document.

setAttribute

Adds an attribute with the specified name and value to the current element.

setAttributeNode

Adds the specified attribute node to the current element.

setAttributeNodeNS

9

Adds the specified attribute node to the current element.

setAttributeNS

9

Adds an attribute with the specified namespace, name and value to the current element.

setCapture

Sets the current object to capture mouse events that occur within the entire browser window.

setExpression


9

Sets a dynamic expression for the specified DHTML property on the current element.

swapNode

Interchanges the positions of the current element and the specified element in the document hierarchy.

onactivate

Occurs when an element becomes active.

onbeforeactivate

Occurs before an element becomes active.

onbeforecopy

Occurs before the selection is copied to the clipboard and before the oncopy event.

onbeforecut

Occurs before the selection is cut from the document and provides a possibility to enable the Cut menu item.

onbeforedeactivate

Occurs on the active element before it loses the active state.

onbeforeeditfocus

Occurs before an input:file, input:password, input:text or textarea element or an element in an editable region becomes a UI-activated.

onbeforepaste

Occurs before the contents of the clipboard are pasted into the document and provides a possibility to enable the Paste menu item.

onblur

Occurs when an element loses focus.

onclick

Occurs when the user clicks on an element.

oncontextmenu

Occurs when the right mouse button is clicked on an element and the context menu is shown.

oncontrolselect

Occurs before a control is selected in an editable region.

oncopy

Occurs before the selection is copied to the clipboard.

oncut

Occurs before the selection is cut from the document and added to the clipboard.

ondblclick

Occurs when the user double clicks on an element.

ondeactivate

Occurs on the active element when it loses the active state.

ondrag

Occurs periodically on the source element during the drag operation.

ondragend

Occurs on the source element when the user has finished the drag operation.

ondragenter

Occurs on an element when the user moves the mouse pointer into it during a drag operation.

ondragleave

Occurs on an element when the user moves the mouse pointer out of it during a drag operation.

ondragover

Occurs periodically on an element while the mouse pointer is over it during a drag operation.

ondragstart

Occurs on the source element when the user starts the drag operation.

ondrop

Occurs on a possible target element when the dragged data is dropped on it.

onfilterchange

Occurs after a filter has changed or finished a transition.

onfocus

Occurs when an element receives focus.

onfocusin

Occurs before an element receives focus.

onfocusout

Occurs after an element loses focus.

onhelp

Occurs after the user has pressed the F1 key.

onkeydown

Occurs on an element that has the focus when a key is pressed down and occurs periodically until the key is released.

onkeypress

Occurs on an element that has the focus when a key is pressed down and occurs periodically until the key is released.

onkeyup

Occurs on an element that has the focus when the user releases a key.

onlosecapture

Occurs when the object loses the mouse capture.

onmousedown

Occurs when the user presses a mouse button over an element.

onmouseenter

Occurs when the user moves the mouse pointer into the area of an element.

onmouseleave

Occurs when the user moves the mouse pointer out of the element.

onmousemove

Occurs when the user moves the mouse over the element.

onmouseout

Occurs when the user moves the mouse pointer out of the element.

onmouseover

Occurs when the user moves the mouse pointer into the element.

onmouseup

Occurs when the user releases a mouse button over an element.

onmousewheel

Occurs when the mouse wheel rolls.

onmove

Occurs when the position of an element's top-left corner is changed.

onmoveend

Occurs when the user stops dragging an absolute or relative positioned element in an editable region.

onmovestart

Occurs when the user starts dragging an absolute or relative positioned element in an editable region.

onpaste

Occurs before the contents of the clipboard are pasted into the document.

onpropertychange

Occurs every time when the value of an element's property is changed.

onreadystatechange

Occurs when the load state of the data that belongs to an element or a HTML document changes.

onresize

Occurs when the size of an object has changed.

onresizeend

Occurs when the user stops resizing an element in an editable region.

onresizestart

Occurs when the user starts to resize an element in an editable region.

onselectstart

Occurs at the start of a selection process.

accelerator

Specifies or returns whether the object contains an accelerator key.

background

Specifies or returns up to five separate background properties, in a shorthand form.

backgroundAttachment

Specifies or returns whether the backgroundImage should scroll with the contents of the object or not.

backgroundColor

Specifies or returns the color to use for the background of the object.

backgroundImage

Specifies or returns the image to use as the background of the object.

backgroundPosition

Sets or retrieves the position of the backgroundImage within the element.

backgroundPositionX

Specifies or returns the horizontal coordinate of the backgroundImage relative to the upper-left corner of the container object.

backgroundPositionY

Specifies or returns the vertical-coordinate of the backgroundImage relative to the upper-left corner of the container object.

backgroundRepeat

Specifies or returns how to tile the backgroundImage relative to the upper-left corner of the container object.

behavior

Sets or retrieves the URL of a behavior file.

border

Sets or retrieves up to three separate border properties, in a shorthand form.

borderBottom

Sets or retrieves the color, style and width properties for the element's bottom border, in a shorthand form.

borderBottomColor

Specifies or returns the color of the element's bottom border.

borderBottomStyle

Specifies or returns the style of the element's bottom border.

borderBottomWidth

Specifies or returns the width of the element's bottom border.

borderColor

Specifies or returns the color of the element's border.

borderLeft

Specifies or returns the color, style and width properties for the element's left border, in a shorthand form.

borderLeftColor

Specifies or returns the color of the element's left border.

borderLeftStyle

Specifies or returns the style of the element's left border.

borderLeftWidth

Specifies or returns the width of the element's left border.

borderRight

Specifies or returns the color, style and width properties for the element's right border, in a shorthand form.

borderRightColor

Specifies or returns the color of the element's right border.

borderRightStyle

Specifies or returns the style of the element's right border.

borderRightWidth

Specifies or returns the width of the element's right border.

borderStyle

Specifies or returns the style of the element's border.

borderTop

Specifies or returns the color, style and width properties for the element's top border, in a shorthand form.

borderTopColor

Specifies or returns the color of the element's top border.

borderTopStyle

Specifies or returns the style of the element's top border.

borderTopWidth

Specifies or returns the width of the element's top border.

borderWidth

Specifies or returns the width of the element's border.

bottom

Specifies or returns the bottom coordinate of a positioned element.

boxSizing

8

Specifies or retrieves how the width and the height of the element are calculated. It affects the height and width properties.

clip

Specifies or returns which part of a positioned element is visible.

clipBottom

Returns the bottom coordinate of the clipping region relative to the upper left corner of the object.

clipLeft

Returns the left coordinate of the clipping region relative to the upper left corner of the object.

clipRight

Returns the right coordinate of the clipping region relative to the upper left corner of the object.

clipTop

Returns the top coordinate of the clipping region relative to the upper left corner of the object.

color

Specifies or returns the color of the element's text content.

content

8

Specifies or returns the generated content after or before the element.

counterIncrement

8

Specifies or retrieves the list of counters and increment values.

counterReset

8

Sets or retrieves the list of counters and their initial values.

cssFloat

Specifies or returns the horizontal alignment of the object.

cssText

Sets or retrieves the contents of a style declaration as a string.

cursor

Specifies or returns the type of cursor to display for the pointing device (mouse).

direction

Specifies or returns the text direction.

display

Specifies or returns the element's display type.

filter

Specifies or returns the filter or collection of filters applied to the object.

font

Specifies or returns up to six separate font properties, in a shorthand form.

fontFamily

Specifies or returns the font face for text.

fontSize

Specifies or returns the font size of the text.

fontStyle

Specifies or returns whether the style of the font is normal, italic or oblique.

fontVariant

Specifies or returns a variation of the specified or default fontFamily.

fontWeight

Specifies or returns the font weight of the text.

hasLayout

Returns a Boolean value that indicates whether the object has layout or not.

height

Specifies or returns the height of the visible area for an element.

layoutFlow

Specifies or returns the flow and direction of the content in an element.

layoutGrid

Specifies or returns up to four separate layout-grid properties that specify the layout of text characters.

layoutGridMode

Specifies or returns whether the text layout grid uses one or two dimensions.

left

Specifies or returns the left coordinate of a positioned element.

length

9

Returns the number of properties that have been set in the current style object.

letterSpacing

Specifies or returns the amount of space between letters.

lineHeight

Specifies or returns the distance between lines of text in a block-level element.

margin

Specifies or returns a shorthand property for setting the top, right, bottom and left margins, in that order.

marginBottom

Specifies or returns the bottom margin of the object.

marginLeft

Specifies or returns the left margin of the object.

marginRight

Specifies or returns the right margin of the object.

marginTop

Specifies or returns the top margin of the object.

opacity

9

Sets or retrieves the transparency level of an element. For Internet Explorer, use filter with 'Alpha(opacity=percent)'.

outline

8

Specifies or returns a shorthand form for all outline properties at once. Outline is a line around an element, but different from the border property.

outlineColor

8

Specifies or returns the color for the outline for an element.

outlineStyle

8

Specifies or returns the style for an element's outline.

outlineWidth

8

Specifies or returns the width for an element's outline.

padding

Specifies or returns a shorthand property for setting the top, right, bottom and left spaces between an element's border and its contents, in that order.

paddingBottom

Specifies or returns the space between an element's bottom border and its contents.

paddingLeft

Specifies or returns the space between an element's left border and its contents.

paddingRight

Specifies or returns the space between an element's right border and its contents.

paddingTop

Specifies or returns the space between an element's top border and its contents.

pixelBottom

Specifies or retrieves the value of the bottom style property, in pixels.

pixelHeight

Specifies or retrieves the value of the height style property, in pixels.

pixelLeft

Specifies or retrieves the value of the left style property, in pixels.

pixelRight

Specifies or retrieves the value of the right style property, in pixels.

pixelTop

Specifies or retrieves the value of the top style property, in pixels.

pixelWidth

Specifies or retrieves the value of the width style property, in pixels.

posBottom

Specifies or retrieves the value of the bottom style property as a floating-point number that specifies the value in the current unit type of the bottom property.

posHeight

Specifies or retrieves the value of the height style property as a floating-point number that specifies the value in the current unit type of the height property.

position

Specifies or returns what type of positioning method is used to render the current element.

posLeft

Specifies or retrieves the value of the left style property as a floating-point number that specifies the value in the current unit type of the left property.

posRight

Specifies or retrieves the value of the right style property as a floating-point number that specifies the value in the current unit type of the right property.

posTop

Specifies or retrieves the value of the top style property as a floating-point number that specifies the value in the current unit type of the top property.

posWidth

Specifies or retrieves the value of the width style property as a floating-point number that specifies the value in the current unit type of the width property.

quotes

8

Specifies or returns the pairs of quotation marks for the 'open-quote' and 'close-quote' values of the content property.

right

Specifies or returns the right coordinate of a positioned element.

rubyAlign

Specifies or returns the horizontal alignment of the Ruby text defined by the rt tag, relative to the base text defined by the ruby tag.

rubyOverhang

Specifies or returns the Ruby text position, relative to the base text defined by the ruby tag.

rubyPosition

Specifies or returns the position of the Ruby text (rt).

styleFloat

Specifies or returns the horizontal alignment of the object.

textAutospace

Specifies or returns the spacing rules between Western and Asian-based (such as Japanese and Chinese) characters.

textDecoration

Specifies or returns the appearance characteristics of text, whether it is underlined, overlined, lined-through or blinking text.

textDecorationBlink

Sets or returns a Boolean value that indicates whether the text blink feature is enabled for the element.

textDecorationLineThrough

Sets or returns a Boolean value that indicates whether the text is displayed with a line in the middle.

textDecorationNone

Sets or returns a Boolean value that indicates whether any text decoration is allowed for the element.

textDecorationOverline

Sets or returns a Boolean value that indicates whether the element is displayed with a line at the top, or not.

textDecorationUnderline

Sets or returns a Boolean value that indicates whether the element is displayed with a line at the bottom, or not.

textTransform

Specifies or returns the case of the text.

textUnderlinePosition

Specifies or returns the position of the underline decoration.

top

Specifies or returns the top coordinate of a positioned element.

unicodeBidi

Specifies or returns whether the text should be overridden to support multiple languages in the same document. Use with the direction property.

visibility

Specifies or returns whether the element is visible.

whiteSpace

Specifies or returns how spaces, tabs, and newline characters inside the element are handled.

width

Specifies or returns the width of the visible area for an element.

wordSpacing

Specifies or returns the spacing between words.

wordWrap

Specifies or returns whether the current line should break if the content exceeds the boundaries of its container.

writingMode

Specifies or returns the intrinsic writing direction of the element's content.

zIndex

Specifies or returns the stack level of positioned objects.

zoom

Specifies or returns the zoom level of the element's content.

Example HTML code 1:

This example illustrates the use of the ruby element:

<ruby>
    Base Text within the ruby element
    <rt>Ruby Text within the rt element</rt>
</ruby>

Copy Code

Preview

Syntax Highlighter

Did you find this example helpful? yes no

Example HTML code 2:

This example shows how to create an ruby element in JavaScript:

<head>
    <script type="text/javascript">
        function AddRuby () {
            var ruby = document.createElement ("ruby");
            var rt = document.createElement ("rt");
            var baseText = document.createTextNode ("Base Text within the ruby element");
            var rubyText = document.createTextNode ("Ruby Text within the rt element");
            rt.appendChild (rubyText);
            ruby.appendChild (baseText);
            ruby.appendChild (rt);

            var container = document.getElementById ("container");
            container.appendChild (ruby);
        }
    </script>
</head>
<body>
    <button onclick="AddRuby ()">Create a new ruby text</button>
    <br /><br />
    <div id="container"></div>
</body>

Copy Code

Preview

Syntax Highlighter

Did you find this example helpful? yes no

External links:

ruby element (MSDN)

Digg Del.icio.us Reddit Facebook Twitter Diigo

User Contributed Comments

ruby object

Syntax:

Possible members:

Example HTML code 1:

Example HTML code 2:

Related pages:

External links:

Post Content