Walls
Walls class
Encapsulates the object that represents the walls of a 3-D chart.
class Walls extends Floor;
Constructors
| Name | Description |
|---|---|
| constructor(Floor) | Constructs from a parent object convertible to this. |
Methods
| Method | Description |
|---|---|
| getCenterX() | Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart’s width after calls Chart.Calculate() method. |
| getCenterY() | Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart’s height after calls Chart.Calculate() method. |
| getWidth() | Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method. |
| getDepth() | Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method. |
| getHeight() | Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method. |
| getCenterXPx() | Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method. |
| getCenterYPx() | Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method. |
| getWidthPx() | Gets the width of left to right in units of pixels after calls Chart.Calculate() method. |
| getDepthPx() | Gets the depth front to back in units of pixels after calls Chart.Calculate() method. |
| getHeightPx() | Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method. |
| getCubePointCount() | Gets the number of cube points after calls Chart.Calculate() method. |
| getCubePointXPx(number) | Gets x-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight |
| getCubePointYPx(number) | Gets y-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight. |
| isNull() | Checks whether the implementation object is null. |
| getBackgroundColor() | Gets or sets the background Color of the Area. |
| setBackgroundColor(Color) | Gets or sets the background Color of the Area. |
| getForegroundColor() | Gets or sets the foreground Color. |
| setForegroundColor(Color) | Gets or sets the foreground Color. |
| getFormatting() | Represents the formatting of the area. |
| setFormatting(FormattingType) | Represents the formatting of the area. |
| getInvertIfNegative() | If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged. |
| setInvertIfNegative(boolean) | If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged. |
| getFillFormat() | Represents a FillFormat object that contains fill formatting properties for the specified chart or shape. |
| getTransparency() | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| setTransparency(number) | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| getBorder() | Gets or sets the border Line. |
| setBorder(Line) | Gets or sets the border Line. |
constructor(Floor)
Constructs from a parent object convertible to this.
constructor(obj: Floor);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | Floor | The parent object. |
getCenterX()
Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
getCenterX() : number;
getCenterY()
Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart’s height after calls Chart.Calculate() method.
getCenterY() : number;
getWidth()
Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
getWidth() : number;
getDepth()
Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
getDepth() : number;
getHeight()
Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method.
getHeight() : number;
getCenterXPx()
Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
getCenterXPx() : number;
getCenterYPx()
Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
getCenterYPx() : number;
getWidthPx()
Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
getWidthPx() : number;
getDepthPx()
Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
getDepthPx() : number;
getHeightPx()
Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
getHeightPx() : number;
getCubePointCount()
Gets the number of cube points after calls Chart.Calculate() method.
getCubePointCount() : number;
getCubePointXPx(number)
Gets x-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight
getCubePointXPx(index: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number |
getCubePointYPx(number)
Gets y-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight.
getCubePointYPx(index: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getBackgroundColor()
Gets or sets the background Color of the Area.
getBackgroundColor() : Color;
Returns
setBackgroundColor(Color)
Gets or sets the background Color of the Area.
setBackgroundColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getForegroundColor()
Gets or sets the foreground Color.
getForegroundColor() : Color;
Returns
setForegroundColor(Color)
Gets or sets the foreground Color.
setForegroundColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getFormatting()
Represents the formatting of the area.
getFormatting() : FormattingType;
Returns
setFormatting(FormattingType)
Represents the formatting of the area.
setFormatting(value: FormattingType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FormattingType | The value to set. |
getInvertIfNegative()
If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
getInvertIfNegative() : boolean;
setInvertIfNegative(boolean)
If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
setInvertIfNegative(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getFillFormat()
Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
getFillFormat() : FillFormat;
Returns
getTransparency()
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
getTransparency() : number;
setTransparency(number)
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getBorder()
Gets or sets the border Line.
getBorder() : Line;
Returns
setBorder(Line)
Gets or sets the border Line.
setBorder(value: Line) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Line | The value to set. |