JSON API - addShape

addShape

PREMIUM TRIAL / ADVANCED

Inserts a shape into the Excel spreadsheet.

Note

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

JSON data
Key Description
type
  • accentBorderCallout1, accentBorderCallout2, accentBorderCallout3, accentCallout1, accentCallout2, accentCallout3, actionButtonBackPrevious, actionButtonBeginning, actionButtonBlank, actionButtonDocument, actionButtonEnd, actionButtonForwardNext, actionButtonHelp, actionButtonHome, actionButtonInformation, actionButtonMovie, actionButtonReturn, actionButtonSound, arc
  • bentArrow, bentConnector2, bentConnector3, bentConnector4, bentConnector5, bentUpArrow, bevel, blockArc, borderCallout1, borderCallout2, borderCallout3, bracePair, bracketPair
  • callout1, callout2, callout3, can, chartPlus, chartStar, chartX, chevron, chord, circularArrow, cloud, cloudCallout, corner, cornerTabs, cube, curvedConnector2, curvedConnector3, curvedConnector4, curvedConnector5, curvedDownArrow, curvedLeftArrow, curvedRightArrow, curvedUpArrow
  • decagon, diagStripe, diamond, dodecagon, donut, doubleWave, downArrow, downArrowCallout
  • ellipse, ellipseRibbon, ellipseRibbon2
  • flowChartAlternateProcess, flowChartCollate, flowChartConnector, flowChartDecision, flowChartDelay, flowChartDisplay, flowChartDocument, flowChartExtract, flowChartInputOutput, flowChartInternalStorage, flowChartMagneticDisk, flowChartMagneticDrum, flowChartMagneticTape, flowChartManualInput, flowChartManualOperation, flowChartMerge, flowChartMultidocument, flowChartOfflineStorage, flowChartOffpageConnector, flowChartOnlineStorage, flowChartOr, flowChartPredefinedProcess, flowChartPreparation, flowChartProcess, flowChartPunchedCard, flowChartPunchedTape, flowChartSort, flowChartSummingJunction, flowChartTerminator, folderCorner, frame, funnel
  • gear6, gear9
  • halfFrame, heart, heptagon, hexagon, homePlate, horizontalScroll
  • irregularSeal1, irregularSeal2
  • leftArrow, leftArrowCallout, leftBrace, leftBracket, leftCircularArrow, leftRightArrow, leftRightArrowCallout, leftRightCircularArrow, leftRightRibbon, leftRightUpArrow, leftUpArrow, lightningBolt, line, lineInv
  • mathDivide, mathEqual, mathMinus, mathMultiply, mathNotEqual, mathPlus, moon
  • nonIsoscelesTrapezoid, noSmoking, notchedRightArrow
  • octagon
  • parallelogram, pentagon, pie, pieWedge, plaque, plaqueTabs, plus
  • quadArrow, quadArrowCallout
  • rect, ribbon, ribbon2, rightArrow, rightArrowCallout, rightBrace, rightBracket, round1Rect, round2DiagRect, round2SameRect, roundRect, rtTriangle
  • smileyFace, snip1Rect, snip2DiagRect, snip2SameRect, snipRoundRect, squareTabs, star10, star12, star16, star24, star32, star4, star5, star6, star7, star8, straightConnector1, stripedRightArrow, sun, swooshArrow
  • teardrop, trapezoid, triangle
  • upArrow, upArrowCallout, upDownArrow, upDownArrowCallout, uturnArrow
  • verticalScroll
  • wave, wedgeEllipseCallout, wedgeRectCallout, wedgeRoundRectCallout
position Cell position in the active sheet: "A1", "C3", "AB7"...
colOffset
  • "from" column size offset from.
  • "to" column size offset to.
colSize Number of columns used by the image.
customGeom Custom geometry.
editAs Possible values are:
  • "oneCell" (default): move but don't size with cells.
  • "twoCell": move and size with cells.
  • "absolute": don't move or size with cells.
fillColor "#FF0000", "#00FFFF"...
imageContent Image path, Base64 string, or URL.
name Sets a name value.
outlineColor "#FF0000", "#00FFFF"...
rotation 60.000ths of a degree.
rowOffset
  • "from" row size offset from.
  • "to" row size offset to.
rowSize Number of rows used by the image.
tailEnd
  • arrow
  • diamond
  • none
  • oval
  • stealth
  • triangle
textContents Text contents.
textStyles
  • "align" left, center, right.
  • "verticalAlign" top, middle, bottom.
Code samples

Example #1

Release notes
  • phpxlsx 6.0:
    • new action.