JSON API - addBackgroundImage

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addBackgroundImage

PREMIUM

TRIAL / ADVANCED

Inserts a background image into a Word document.

Note

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

JSON data

{
    "src": "string",
}

Key	Description
src	Path to the local image, Base64 string, or URL.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addBackgroundImage",
            "data": {
                "src": "image.jpg"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Please, use a discrete background image so the text is easily readable."
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This one is pretty annoying but it illustrates well the functionality :-)"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addBackgroundImage",
            "data": {
                "src": "https://www.phpdocx.com/img/logo_badge.png"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "New content with a URL image as background."
            }
        }
    ]
}

Example #3

{
    "actions": [
        {
            "action": "addBackgroundImage",
            "data": {
                "src": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpCQjFENDA3NDY3NDlFOTExQUFEMTg1Njg4OEEwNTk0MSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOEVFNkRBRUQxODkxMUVBODExQkUxMDNBRkJDNjU0NiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOEVFNkRBREQxODkxMUVBODExQkUxMDNBRkJDNjU0NiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M2IChXaW5kb3dzKSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkFGNjJGOEQ3RTU0QkVBMTE4M0RDQjhDRjFGRkZGOUNCIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkJCMUQ0MDc0Njc0OUU5MTFBQUQxODU2ODg4QTA1OTQxIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+lKhLEwAAFLVJREFUeNrsnQ2QZFV1x+/AKiyusAMILEZI9ShBIxZxduMnySb0yMYkEE1mVaQUTTKTpFJl/MpMrJAEo7KTVMTCULpDqUkUSe1YJkakJNsqAooaBjUYBYQRQ8guiNu7LCwKwuScfbdN03T3e/d93vv696s6NTM93X3fve/87z33842trq4aAKg3YwgdAKEDAEIHAIQOAAgdABA6ACB0AEDoAIDQARA6ACB0AEDoAIDQAQChAwBCBwCEDgAIHQChAwBCBwCEDgAIHQAQOgAgdACondDHxsa4M9k5VOwYsRPFThB7uv19g9h6sePF1ood1fX+Y7X4u77jYbE99vfHxO4T+7HYLvv7PWK7xe6yr+nv949yofvacCL0GlTWYs8Q+zmxk8VOEXumtZ+xoi6jQLVS+IHY3WK3iN0m9j2xO8S+21VhIHSEjtAToiJ+gdiviE3av9d5fL33in1L7Ktinxf7pq0UEDpChy5OtKI+Q+wXxE6zYXeoqMi/bq0ldoPYgwgdofvAGrEniR0mdkjX64/asPVh+3teaF/6TLFXiG0WO7rGFdntYp8T+0Tookfo4Qj9MNvPfZ61Z5loIEtD48PtzzU9fdMD1h4w0aCU9klvErvZ/v5IwrSfKnaO2GtsaH7MCEYvd4rtFPu42DUIHaHnyc+KbRLbYsPjholGobPyExMNSl0ndrXY10w0WNXLc8ReJXaeTRsiviz2EbErTTSij9ARujNPEft1sTeKvdT+XTT7xK4X+5DYtbZy+WOxl9luAfRHp/J2iF0q9m2EjtCToFNQrxY7X+zUCrOpc9DHo2EnfiT2UZ/DeoRevdC1//sW24Iei2aC55Ni7zLRyD1CR+gHeaMV+c+jj1qhA6CXi10s9h2EPrpC15Vhf2tDdagvOvaxzfbh9yP00RL6VrH3mWg+GkYDXXr7F2JLCL3+QtdpsYvE3o7fjywfE/trE01tIvQaCv1IE43Kno2vjzxtsTdZf0DoNRK69sd1rvVF+Dh0oVNxbzbRxhqEHrjQddPHZ0202QOgFw3hZ00Jc+8IvTiha0v+abHT8WcYgi62udBEo/MIPTCh6yIY3fW0CT+GhHzE9t33I/QwhK5bRXVb4yvwXXBEdxZOi60gdP+FviD2p/gsZOi364rJLyF0f4Wu02efwlchI7qE9pUm2kKM0D0Tup6PpvuUn4afQg5oX/1tYosI3S+hXyX2a/gn5Iwe+nE5QvdD6Lo55Qp8EgpAz63XhTWXIPRqha7np+ne42fgk1AgrzMZls0i9OxCf7fYO/BDKKFl1/P7PoHQyxe6Drzpof9sOYUy0P3tOrNzLUIvV+gXiL0T/4MS0YdMvNhEZ84j9BKEPm6ix/mciO9Byejx3L9qHB4o4avQDwmgsLcgcqiIXxT7YB0yEkKLroMiv43PQYXMiF1G6F6c0LUl1wP7j8LXoEL0me/6kMubEHoxQn+D2IfxM/AAFflG1TJ99Px5Of4FnvB8E/BuSZ9bdH0Wmh7Kz0o48AU9pUYH6G4mdM9P6M+2BXoo/gUecY3trxO658RJiBw8ZLOJnn4bFD4LnRNdwVfeK3Y4Qs+HU/An8BR9WOe5IV2wz330ltiZ+BR4yjdMNN32KH309GjfnGeYg8/ocwTOoUXP1qKvNdGI+wT+BB5zg9gZ3a0602tuQj/aRNsDx/El8JxfEruO0D0dqyZmqSGAJwQRvvvaoh8nP24VW48fgefcZaLFXQ/SorujA3Hr8CEIAF2i7f3skM+hO0AovIrQPV3o/iL5cb0J4wQcgN1ip4rtI3R34whEDgFxgtizCN3deQzfgcB4AUJPV0MChMRLEbo7a/EbCIxNYochdEJ3qDc6zXYSQid0h3rzZBONvCN0QneoOachdEJ3qD8TCJ0WHerPyQjdjePxGQiQIxG6G6x1hxBZh9AROtQf5tHrUmAAQ1iD0N3YgM9AgDwVoQPUn1WEDlB/xhA6QP35CUKnAoL6sx+hu8FTWgBo0QFo0REUQDU8iNAB6s+9CB2g/tyJ0AHqz3cQOkD9ucXXC/P1SS3/JT+eg99AQOwVO0X09ANadID6cpvYDwndAerNl43HZx0idIB8+ILPF+drH/0e+XEcvgOB8IiJznRf8fVpqr4KfY/8GMd/IBCWTfSQxUd5bLKj1vEdCIhPq8gJ3d1b9O+b/J5j9UETrUF+K/4IBaB70E8X0ylhQ4vuxv05fc9fif2h2GViD+OTUADXdETuM3Xepvp3Yhfa328Vuw6fhAJYCuEi6zq99n6xt/W89lF8EnJmn9iVCL0abhab6/O63pB78U3IkcvF/hehl88BsdeKPdTnf7o88QP4JuSEnibzN6FcbN2Efolt0Qfx96HUwOA9nxH7PkKvpoa9NOY994n9Ez4KGXk4pNa8bkL/kNj/JHiftur34KuQAZ2u/XpIF1yX/ei61lgXLXw74fv/gP46pET3nZ86qLFgwYyj1h3f/x/G7RgfrZG/gs9CChZCjAh9Ffpex/eraF2qUl2XfIHxeP8weMmNYheHeOG+Cv2A4/u/lCKNlth78V1IiA7A/a7YjxF6NaH7gzZ0T8NfOvTrgZD9P0O9+DqMuutI++4MkYNuenkEP4Yh6OkxF4acgTpsavleRqFeK/Yn+DIMQFdUnm88328eqtDbDu9dySE9nWr7JD4NPWgD8vti/x16RnwV+h6H9+7OIT0dsX+d2FfxbehiXuxf6pCROoTuea1d10G914vdjX+D8GET6FRaSEJ3GXXPs++kB1ScI/YAfj7SfMaG7KsIvVhcHmuzK+e09UTPVxuOnhpVvmgju1otpvJV6C4tahGC1Br9DSY6+A9GB135drbx+NFKdRP6moLCfBc+bqIBOsQ+Gnxe7OUmv4NJgxVUmbgUdpH9qCvsT90CuxYt1JYbxF5pojPgakkd+uhFC/AKG87djx5qyZW2Jd9X50zWIXQ/oYTr0Q0wW0yygy0gHPRwx2njvlsSoVfQopc1BaLh3Waxm9BHLXi32HliPxqFzPoq9P2etegd7hCb6uq7Q3iob71G7M9HKdO+Cv0xh5b6yJKvTZfnnit2kQl8o8MIcrvYb4n986hl3Feh3+cgomMqusZ32H77XegnCHTT0gtNNI1mEHp4PFfsSRWlrYN0Z4p9Ch15y0O2UtZBtx+ObCnoqZW+me1377PhexJ7vwdF+XbrVKuYN/YNsZeMup4OaspToR9t+8IuN/VcD8S+yUSP0UVk1Zqe6/aeCsZvvBW6r+e6rzPRM6dPcviYHsH7PFP9gxR1DYCeWHNBFY4GBx+soOV/bVURMqF78hZ9jRW6a01+gUdF+0yxf6B1Lc0esQJfi56eaL4OxumNO5Dic78ndpQnedCpnPPFfkPsazS0xQeCtpwfoijCGXXXqbVbUnzuJDu66hO65fUiXK1wDjXR1mIISOhK2vPbzvYwL5txtVI4zdTvUeC1F3rawRQdkDvCs7w0cLVSmPCo64bQE6IPTUzzBBa90b7tHV+Hq5WC3vunUQxhCV1HUd+V8nO+rUFfxdVK8+cnUwxhCV35N7GPOX5GD9vnkIjRRCv5AxRDeEJX/sy4jcBfb/w7wXMPrlYKuhnqHoohTKHrqS6/aaJnrMWhtfkHPMzDd3G1UrjNRA/igACFrujiE90SetWQ0EwPhdADBW718PpbJYSsuv1Sn0Pny4kpemT3t0y091t3j/2OKf6xw19B0v3xda37sH/rVNUpYqeKrTfRue46Qv85j/vmuqRXZxBOL+j7/13sLBPNNjzdRMtvtXwmbFltEDve/l8Hqw7LmN6qrVC07HWXoT7/7m5b2d5u78ed9rXugdE/Eru0oDLQjSzPNxU/797Xte4hCj1UdCFPEfvW9Qa+OKY108hNN9joNN8RXT9V9EfZCjOOXVbYD1hR7bdh8gMO4fJTTLSH4eQCyuESsTdVfZPZ1OK2qaWuXGXy38xxWWBlcF4BZaBRxLHoKbz96HXlONtvzcvBte9/eIDl8M4cy0Ajipf4kjGEjtA7PNtEo8NZHfwaE+5yT+1KLOZQBnuNZ3sbEDpC7+ZEO3iY1sH/0dRjWe1cxnD9DLrCCN13NOTWgxJWHJz7m2KvrVk5bDbRY5GSloGO8l9syj3PP3ihM+pePeMmmmPW88YbdlCps75Bp6b0qTW6NmBJ7F9NfQ9W+GVbiW2yIu5es67Tprq0+WqxHbY193Zw20fGRqgFBRhZEDoAQgcAhA4ACB0AEDoAIHQAQOgAgNABAKEDIHQAQOgAgNABAKEDAEIHAIQOAAgdABA6AEIHAIQOAAgdABA6AIyy0As62nmnWLPr7ylT/KOLg2bXWev1YQrbBvy7teHqvVOUUv6Upb9DKGqA+oPQARA6ACB0AEDoAIDQAQChAwBCBwCEDgD/zxpPrqN7FVtbbLmitJVWXfK866z1kzad7rRWrC1tuHrvStGZlGsYt+k3xPR6xvvke1mupVVw2h3rd6915d9yn89OxiSh191OeB19v2v3lp8Wx/IJn223gxP62NjYtq7MLa+urs53/U9zNyM2PaQwl+yNWMz50pKkvWLTX7S/J+VxeRabd0w3lzyLY03ba2kMu1Z5n6azUITg5bs17Tmb52FM2/e3bb4XkognQQU3kyDtZtdn2p17rqLXa5DXtsWIXa93NsElzVkbWGGIyDcWWeEWttZdxNy93rwl6UzZ1/XGbu+p2YfWmrYwXVq8QWvdXdM2VqwLKdJt2XRNinTT5LnjsNtinKqXtr3OcXv9/XBa657iGnqvR8W+kCLv4wlElYSjrdBV5DfGvHdqWDSS8Ds2itALjWLL6qM3rci1ht3hKLRJ64CTGa8hTdqdVnp7htC8tDynFFhH4I08QmWxGzMKbdxGG9tTiHxnDiJf7EQUNpyfT+Afw4jLx3zRIi9T6CryuZ5Mr9iWcta2KGpb7WvtAc44maGi2d7TaizamzjVZfMD+uhJwsBBIVspebbh+lwWceVwm3fkUCH/tMwdxb4zp7Qfd/9tZDFMiJN251+/ezIXc00asi+Uor+SQvcnhGaS7oJ93zDHm+kT0m5MeNObGULxZp9WWEU6kTLdtk1zIYHYUuVZnOqOPFrltKF7zDbXLGyVtJdKSntF0ppIEX7r/d3YPdZhxyhujInkNpbRmpfaonffuI7IYwputs+g1GTKlrXDbML+dqvPIEsjQ4uxNUG6qfMsTjWTQOSdyqYTSfRLK+vAm0v6gyKZJ4S+NiwflnYSkS/aNLujt8We9PuWR4IQfrxPiL4tRuTzvSP9RVL29NqiiLzlKMzJHoHNpHTQJcfPLdlWvNHT0rvenEXjNmWXJs/NmO9ctoNG7T5CWbSRyHiG+zod8/lB6S9J+gsxYXdntmJhyNhLXAUz1UdUnXsya7s9TXvPzQCxL9j3DbrOpv5fow/7vulh5ZFmsDGkFn0hh89MpgxRF1JWDr1O51WebWs3nSD8bQ9prbZm7U8nENqg9Duj/u2U3x8n9Km4llPFKTabYJoxbiptW8IIY7Zk3ZUq9BVpzVdSiq3dpwVxStukW5DS7iM413SLznPcNS3GObCdHkoVRtr+ayMm/XZM+u2YiKVhBdQv7fGYtHMLjxOE8A0TP4NRashehdCzrHxa6lOgZaS9HECeJx2/J+v7XLsNrZzKqllg2i5ijxuFb/gUslfSouf42UaJafue5/EErXUZlVqm9BO8L023qajlzLMlfy64PnpaljMKPUSS5nmy4gquWVJ5OLfoWZfSZgjhvQnZQ2vRTUahh9iiZ82zU/pFbCpJ0aLmWV6FiipBCO9FyF6F0NsV5rM9YumGykpgZd+uIF/eC70xgo7bGHHhuvarJytM2wm7Gi9pt2V60DLZOgo9z4Jv19TR887zpIPjNgu4rskcy6tdYaXRW1ZJVgL2MtdvirCOQs/CZJn9r8Dy3KqqVUtyL4YtX+0jHtd0ckk7BdtTlG2/ZbK1FHqWGrYRaIteeZ7tcswirzWu/9nMKf12ilZ+Ou8bmiBkH3ZNzapC+FCE3gy0RS8jz8s5CS2tKFo5fe90inSWyxR6gpD94C62GLFXEsKXOhg3NjbWSOnwDUfn8oV+55TlmucE02IzdqloXKufqlKyc9XDVtVNx/X/7f/jNoGspMh70yGiObgLMKas4kL2eXudrjvdatdHn8vhM2nXrVdFGXmOW766c5DYrBCyOl7crsAdQ9Lv7P1P+/1xaW8fJnZ7Ks6MPRlnoJAThOy6Z3/RVkBxOxZLD+HL3qY6I626blVddnD4puON9Y3OFtMi87wY0yKOW7Evd1UKnV1vmcNIbVnlu1tDhNCdfqsrtE0SSax0BDSkkpuJybtWNJ0DP9s90VZs1ybhKPtsn7/viAnhl0xJc+xVHPe8U8S+NcG+dL152/q0bKEJ/WCeTbQVtJA8JxBa95hBUdNO8yZ+X3ua9GcT5H0pQX88zZSYa8jefV0rcl3zZvCW1U4IP1WGA1axe23cin2HPSyy0ZP5aesw2wfc9JBWmz0uzzZELSrP8xmvNVMFmnL9d6zIEy7NLcwvEoTsK4OWt9rXh7XYzd1bxufqJvTe8LXTN9TwZtXaHiuG5oCb2TJhUVqerdDS7o7SfduzWcNIG2LnJbrZmJC9O90kh1ekEXmakN31/3Mi9kadhN65GUspPpfb+WYlU2qeUwqtI/Jcxj/sNUxlqJS1splKKvKeim4iY2PQ7qns4kL2xbiIw/5/KWYMYXudhG6kX94W25rQ+TunjkwEKvLufJSWZyuQjQk+f/AIqS6Rm7zK2T7pZMqxkluyrfhE2p102rJ3pbvoUOF1uh0Tnb52woUxSbsqcZVv4SF8mcc9T/UOwNlHM/UboFkOMEw3ZvATYnpr8FLy3PXMr8meFnO5jOeu9VxLs0+e27aP2yow3c5RV40BAl8puyx6Gr/yEirCrNOvdllzwPvqxBPybAAq0F+v8dhkgBEAoQMgdABA6ACA0AEAoQMAQgcAhA4ACB0AEDrASDFWw2WoAIDQARA6ACB0AEDoAIDQAQChAwBCBwCEDgAIHQChAwBCBwCEDgAIHQAQOgAgdABA6ACA0AEAoQMgdACoC/8nwACCD7s7vE5oewAAAABJRU5ErkJggg=="
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "New content with a base64 image as background."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.