JSON API - addRuby

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addRuby

PREMIUM

TRIAL / ADVANCED

Inserts a ruby (phonetic guide).

Note

You are reading the JSON API documentation. For the PHP API method please go to addRuby.

JSON data

{
    "ruby": {
        "rt": "string",
        "rubyBase": {
            "text": "string",
            /* check addText styles */
        }
    },
    "options": {
        "rubyAlign": "string",
        "hps": number,
        "hpsBaseText": number,
        "hpsRaise": number,
        "lid": "string",
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
rt	Phonetic guide text.
rubyBase	Phonetic guide base text.
rubyAlign	The possible values are: center distributeLetter distributeSpace (default) left right rightVertical
hps	Phonetic guide text font size. Size in half-points. Default as 11.
hpsBaseText	Phonetic guide base text font size. Size in half-points. Default as 22.
hpsRaise	Distance between phonetic guide text and phonetic guide base text. Size in half-points. Default as 20.
lid	Language ID for phonetic guide. Default as 'en-US'.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addRuby",
            "data": {
                "ruby": {
                    "rt": "Ashita",
                    "rubyBase": {
                        "text": "明日"
                    }
                }
            }
        },
        {
            "action": "addRuby",
            "data": {
                "ruby": {
                    "rt": "さくら",
                    "rubyBase": {
                        "text": "桜"
                    }
                }
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addRuby",
            "data": {
                "ruby": {
                    "rt": "Ashita",
                    "rubyBase": {
                        "text": "明日",
                        "bold": true,
                        "italic": true
                    }
                },
                "options": {
                    "rubyAlign": "right",
                    "hps": 16,
                    "hpsRaise": 40,
                    "hpsBaseText": 32,
                    "bold": true,
                    "font": "Arial",
                    "fontSize": 16
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.