addShape

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addShape

TRIAL / ADVANCED / PREMIUM

Inserts different types of shapes into a Word document.

Description

public addShape ( string $type [, array $options] )

This method inserts a shape into your Word document.

The available types include:

arcs of a circle (filled or not)
bezier curves (filled or not)
straight lines
polylines
rectangles
rectangles with rounded corners
arbitrary shapes (VML paths)
ovals
straightArrow
arrowLeft
arrowRight
customShape

Parameters

type

arc, curve, line, polyline, rect, roundrect, shape, oval, straightArrow, arrowLeft, arrowRight, customShape.

options

The possible keys and values are:

Key	Type	Description
width	int	Shape width given in points.
height	int	Shape height given in points.
position	string	The possible values are: absolute, relative.
marginTop	int	Top margin given in points.
marginLeft	int	Left margin given in points.
relativeToHorizontal	string	margin, page, text, char.
relativeToVertical	string	margin, page, text, line.
z-index	int	Equivalent to the CSS z-index property. Choose a high positive number to make sure that the shape is over the text or a negative number if you want the shape to be behind the text.
strokecolor	string	The chosen line color in hexadecimal value: #ff0000, #00ffff.
strokeweight	float	The width of the line in points: 1.0 pt, 3.5 pt...
fillcolor	string	The chosen fill color in hexadecimal value: #ff0000, #00ffff.
textContent	mixed	WordFragment, a plain text string or an array with same parameters used in the addText method.
imageContent	string	File path to the image to be added.

Options for specific types:

Key	Type	Description
arc
startAngle	int	The angle of the tangent line at the initial point of the arc.
endAngle	int	The angle of the tangent line at the final point of the arc.
line and curve
from	string	The x and y coordinates of the initial point in the format "x,y".
to	string	The x and y coordinates of the final point in the format "x,y".
control1	string	The final control point for the bezier curve (it does not apply for plain lines) in the format "x,y".
control2	string	The final control point for the bezier curve (it does not apply for plain lines) in the format "x,y".
roundrect
arcsize	float	A number describing the "roundness" of the rectangle corners: 0.5, 1.8.
shape
path	string	The VML path describing the shape. You need a working knowledge of the VML standard.
coordsize	string	The VML path describing the shape. You need a working knowledge of the VML standard.
straightArrow, arrowLeft, arrowRight, shape, customShape
extraShapeStyles	string	Extra shape styles.
opacity	int	0 to 100.
rotation	int	Shape rotation.
customShape
customShape	string	Custom shape XML.

Exceptions

Image does not exist.

Image format is not supported.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addText('Arc:');
$options = array(
    'width' => 70,
    'height' => 70,
    'fillcolor' => '#555555',
    'strokecolor' => '#ff0000',
    'strokeweight' => '4',
    'startAngle' => 0,
    'endAngle' => 210,
);
$docx->addShape('arc', $options);

$docx->addText('Curve:');
$options = array(
    'from' => '300,40',
    'to' => '120,150',
    'fillcolor' => '#555555',
    'strokecolor' => '#ff0000',
    'strokeweight' => '4',
    'control1' => '60,70',
    'control2' => '125,170',
);
$docx->addShape('curve', $options);

$docx->addText('Line:');
$options = array(
    'from' => '10,10',
    'to' => '150,10',
    'strokecolor' => '#0000ff',
    'strokeweight' => '2',
    'position' => 'absolute',
    'margin-left' => 20,
);
$docx->addShape('line', $options);

$docx->addText('Polyline:');
$options = array(
    'points' => '10,10 20,20 25,10 40,7 3,55',
    'strokecolor' => '#ff00ff',
    'strokeweight' => '2',
    'position' => 'absolute',
    'marginLeft' => 40,
);
$docx->addShape('polyline', $options);

$docx->addBreak();

$docx->addText('Rectangle:');
$options = array(
    'width' => 60,
    'height' => 20,
    'strokecolor' => '#ff00ff',
    'strokeweight' => '3',
    'fillcolor' => '#ffff00',
    'position' => 'absolute',
    'marginLeft' => 10,
    'marginTop' => -5,
);
$docx->addShape('rect', $options);

$docx->addText('Rounded rectangle:');
$options = array(
    'width' => 60,
    'height' => 30,
    'strokecolor' => '#ff00ff',
    'strokeweight' => '3',
    'fillcolor' => '#ffff00',
    'position' => 'absolute',
    'marginLeft' => 60,
    'marginTop' => 2,
    'arcsize' => 0.3,
);
$docx->addShape('roundrect', $options);

$docx->addBreak();

$docx->addText('Arbitrary shape:');
$options = array(
    'path' => 'm,118hdc80,65,159,24,252,v33,11,66,24,100,34c374,41,413,29,419,51v30,109,-6,
202,-100,234c308,296,299,311,285,318v-31,16,-100,34,-100,34c140,341,
92,339,51,318,33,309,20,288,17,268,14,251,34,218,34,218hal,118hdxe',
    'width' => 40,
    'height' => 40,
    'strokecolor' => '#000000',
    'strokeweight' => '2',
    'fillcolor' => '#ff0000',
    'position' => 'absolute',
    'marginLeft' => 5,
    'marginTop' => 0,
);
$docx->addShape('shape', $options);

$docx->addText('The same arbitrary shape but with negative z-index and a negative margin-top so it is drawn behind this text.');
$options = array(
    'path' => 'm,118hdc80,65,159,24,252,v33,11,66,24,100,34c374,41,413,29,419,
51v30,109,-6,202,-100,234c308,296,299,311,285,318v-31,16,-100,34,-100,
34c140,341,92,339,51,318,33,309,20,288,17,268,14,251,34,218,34,218hal,118hdxe',
    'width' => 50,
    'height' => 50,
    'strokecolor' => '#dddddd',
    'strokeweight' => '2',
    'fillcolor' => '#ffff00',
    'position' => 'absolute',
    'marginLeft' => 25,
    'marginTop' => -45,
    'z-index' => -1000,
);
$docx->addShape('shape', $options);

$docx->addBreak();

$docx->addText('An oval with no fill color and a circle with yellow color:');
$options = array(
    'width' => 100,
    'height' => 60,
    'strokecolor' => '#000000',
    'strokeweight' => '2',
);
$docx->addShape('oval', $options);

$options = array(
    'width' => 100,
    'height' => 100,
    'strokecolor' => '#000000',
    'strokeweight' => '2',
    'fillcolor' => '#ffff00',
    'position' => 'absolute',
    'marginTop' => -75,
    'marginLeft' => 150,);
$docx->addShape('oval', $options);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 14.5:
- straightArrow, arrowLeft, arrowRight, customShapeType, opacity, rotation, extraShapeStyles, relativeToHorizontal and relativeToVertical shape types and options.

phpdocx 12.0:
- imageContent option.

phpdocx 9.5:
- textContent option.