asposediagram.api

Classes

Exceptions

DiagramException

Constants

Class Fill

Contains the current fill formatting values for the shape and the shape's drop shadow, including pattern, foreground color, and background color.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("AddingNewShape.vsdx");

// Get page by ID
page = diagram.getPages().getPage("Page-1");
// Get shape by ID
shape = page.getShapes().getShape(795);
// Get the fill formatting values
console.log(shape.getInheritFill().getFillBkgnd().getValue());
console.log(shape.getInheritFill().getFillForegnd().getValue());
console.log(shape.getInheritFill().getFillPattern().getValue());
console.log(shape.getInheritFill().getShapeShdwObliqueAngle().getValue());
console.log(shape.getInheritFill().getShapeShdwOffsetX().getValue());
console.log(shape.getInheritFill().getShapeShdwOffsetY().getValue());
console.log(shape.getInheritFill().getShapeShdwScaleFactor().getValue());
console.log(shape.getInheritFill().getShapeShdwType().getValue());
console.log(shape.getInheritFill().getShdwBkgnd().getValue());
console.log(shape.getInheritFill().getShdwBkgndTrans().getValue());
console.log(shape.getInheritFill().getShdwForegnd().getValue());
console.log(shape.getInheritFill().getShdwForegndTrans().getValue());
console.log(shape.getInheritFill().getShdwPattern().getValue());

Property Getters/Setters Summary
`method`	`getDel()`
`method`	`setDel(value)`
	A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
`method`	`getFillBkgnd()`
`method`	`setFillBkgnd(value)`
	Specifies the color used for the background of the shape's fill pattern.
`method`	`getFillBkgndTrans()`
`method`	`setFillBkgndTrans(value)`
	Specifies the transparency level for the background (fill) color of the shape's fill pattern, from 0 (completely opaque) to 1 (completely transparent).
`method`	`getFillForegnd()`
`method`	`setFillForegnd(value)`
	Specifies the color used for the foreground (stroke) of the shape's fill pattern.
`method`	`getFillForegndTrans()`
`method`	`setFillForegndTrans(value)`
	Specifies the transparency level for the foreground (fill) color of the shape's fill pattern, from 0 (completely opaque) to 1 (completely transparent).
`method`	`getFillPattern()`
`method`	`setFillPattern(value)`
	Specifies the fill pattern for the shape.
`method`	`getGradientFill()`
	Contains the current gradient fill formatting values for the shape
`method`	`getShapeShdwBlur()`
`method`	`setShapeShdwBlur(value)`
	Specifies the shadow blur size of a shape. cannot draw blur now, but can parse from vsdx now.
`method`	`getShapeShdwObliqueAngle()`
`method`	`setShapeShdwObliqueAngle(value)`
	Specifies the angle of oblique direction of a shape's shadow.
`method`	`getShapeShdwOffsetX()`
`method`	`setShapeShdwOffsetX(value)`
	Determines the distance in page units that a shape's shadow is offset horizontally from the shape.
`method`	`getShapeShdwOffsetY()`
`method`	`setShapeShdwOffsetY(value)`
	Determines the distance in page units that a shape's shadow is offset vertically from the shape.
`method`	`getShapeShdwScaleFactor()`
`method`	`setShapeShdwScaleFactor(value)`
	Specifies the percentage by which the shadow of a shape can be enlarged or reduced.
`method`	`getShapeShdwShow()`
`method`	`setShapeShdwShow(value)`
	Specifies the type of shadow for a shape.
`method`	`getShapeShdwType()`
`method`	`setShapeShdwType(value)`
	Specifies the type of shadow for a shape.
`method`	`getShdwBkgnd()`
`method`	`setShdwBkgnd(value)`
	Specifies the color used for the background (fill) of the shape's drop shadow fill pattern.
`method`	`getShdwBkgndTrans()`
`method`	`setShdwBkgndTrans(value)`
	Specifies transparency level for the background (fill) of the shape's drop shadow fill pattern, from 0.0 (completely opaque) to 1.0 (completely transparent).
`method`	`getShdwForegnd()`
`method`	`setShdwForegnd(value)`
	Specifies the color used for the foreground (stroke) of the shape's drop shadow fill pattern.
`method`	`getShdwForegndTrans()`
`method`	`setShdwForegndTrans(value)`
	Specifies transparency level for the foreground (stroke) of the shape's drop shadow fill pattern, from 0.0 (completely opaque) to 1.0 (completely transparent).
`method`	`getShdwPattern()`
`method`	`setShdwPattern(value)`
	Specifies the fill pattern for a shape's shadow.

Method Summary
`method`	`deepClone()`
`method`	Creates deep copy of this instance.

- Property Getters/Setters Detail
  - getDel/setDel : int
```
int getDel() / setDel(value)
```
    A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
  - getFillForegnd/setFillForegnd : ColorValue
```
ColorValue getFillForegnd() / setFillForegnd(value)
```
    Specifies the color used for the foreground (stroke) of the shape's fill pattern.
  - getGradientFill : GradientFill
```
GradientFill getGradientFill()
```
    Contains the current gradient fill formatting values for the shape
  - getFillBkgnd/setFillBkgnd : ColorValue
```
ColorValue getFillBkgnd() / setFillBkgnd(value)
```
    Specifies the color used for the background of the shape's fill pattern.
  - getFillPattern/setFillPattern : IntValue
```
IntValue getFillPattern() / setFillPattern(value)
```
    Specifies the fill pattern for the shape.
  - getShdwForegnd/setShdwForegnd : ColorValue
```
ColorValue getShdwForegnd() / setShdwForegnd(value)
```
    Specifies the color used for the foreground (stroke) of the shape's drop shadow fill pattern.
  - getShdwBkgnd/setShdwBkgnd : ColorValue
```
ColorValue getShdwBkgnd() / setShdwBkgnd(value)
```
    Specifies the color used for the background (fill) of the shape's drop shadow fill pattern.
  - getShdwPattern/setShdwPattern : IntValue
```
IntValue getShdwPattern() / setShdwPattern(value)
```
    Specifies the fill pattern for a shape's shadow.
  - getFillForegndTrans/setFillForegndTrans : DoubleValue
```
DoubleValue getFillForegndTrans() / setFillForegndTrans(value)
```
    Specifies the transparency level for the foreground (fill) color of the shape's fill pattern, from 0 (completely opaque) to 1 (completely transparent).
  - getFillBkgndTrans/setFillBkgndTrans : DoubleValue
```
DoubleValue getFillBkgndTrans() / setFillBkgndTrans(value)
```
    Specifies the transparency level for the background (fill) color of the shape's fill pattern, from 0 (completely opaque) to 1 (completely transparent).
  - getShdwForegndTrans/setShdwForegndTrans : DoubleValue
```
DoubleValue getShdwForegndTrans() / setShdwForegndTrans(value)
```
    Specifies transparency level for the foreground (stroke) of the shape's drop shadow fill pattern, from 0.0 (completely opaque) to 1.0 (completely transparent).
  - getShdwBkgndTrans/setShdwBkgndTrans : DoubleValue
```
DoubleValue getShdwBkgndTrans() / setShdwBkgndTrans(value)
```
    Specifies transparency level for the background (fill) of the shape's drop shadow fill pattern, from 0.0 (completely opaque) to 1.0 (completely transparent).
  - getShapeShdwType/setShapeShdwType : ShapeShdwType
```
ShapeShdwType getShapeShdwType() / setShapeShdwType(value)
```
    Specifies the type of shadow for a shape.
  - getShapeShdwShow/setShapeShdwShow : ShapeShdwShow
```
ShapeShdwShow getShapeShdwShow() / setShapeShdwShow(value)
```
    Specifies the type of shadow for a shape.
  - getShapeShdwOffsetX/setShapeShdwOffsetX : DoubleValue
```
DoubleValue getShapeShdwOffsetX() / setShapeShdwOffsetX(value)
```
    Determines the distance in page units that a shape's shadow is offset horizontally from the shape.
  - getShapeShdwOffsetY/setShapeShdwOffsetY : DoubleValue
```
DoubleValue getShapeShdwOffsetY() / setShapeShdwOffsetY(value)
```
    Determines the distance in page units that a shape's shadow is offset vertically from the shape.
  - getShapeShdwObliqueAngle/setShapeShdwObliqueAngle : DoubleValue
```
DoubleValue getShapeShdwObliqueAngle() / setShapeShdwObliqueAngle(value)
```
    Specifies the angle of oblique direction of a shape's shadow.
  - getShapeShdwScaleFactor/setShapeShdwScaleFactor : DoubleValue
```
DoubleValue getShapeShdwScaleFactor() / setShapeShdwScaleFactor(value)
```
    Specifies the percentage by which the shadow of a shape can be enlarged or reduced.
  - getShapeShdwBlur/setShapeShdwBlur : DoubleValue
```
DoubleValue getShapeShdwBlur() / setShapeShdwBlur(value)
```
    Specifies the shadow blur size of a shape. cannot draw blur now, but can parse from vsdx now.
- Method Detail
  - deepClone
```
Object deepClone()
```
    Creates deep copy of this instance.
    Returns:

asposediagram.api

Classes

Exceptions

Constants

Class Fill

Property Getters/Setters Detail

getDel/setDel : int

getFillForegnd/setFillForegnd : ColorValue

getGradientFill : GradientFill

getFillBkgnd/setFillBkgnd : ColorValue

getFillPattern/setFillPattern : IntValue

getShdwForegnd/setShdwForegnd : ColorValue

getShdwBkgnd/setShdwBkgnd : ColorValue

getShdwPattern/setShdwPattern : IntValue

getFillForegndTrans/setFillForegndTrans : DoubleValue

getFillBkgndTrans/setFillBkgndTrans : DoubleValue

getShdwForegndTrans/setShdwForegndTrans : DoubleValue

getShdwBkgndTrans/setShdwBkgndTrans : DoubleValue

getShapeShdwType/setShapeShdwType : ShapeShdwType

getShapeShdwShow/setShapeShdwShow : ShapeShdwShow

getShapeShdwOffsetX/setShapeShdwOffsetX : DoubleValue

getShapeShdwOffsetY/setShapeShdwOffsetY : DoubleValue

getShapeShdwObliqueAngle/setShapeShdwObliqueAngle : DoubleValue

getShapeShdwScaleFactor/setShapeShdwScaleFactor : DoubleValue

getShapeShdwBlur/setShapeShdwBlur : DoubleValue

Method Detail

deepClone