Walls

Walls class

Encapsulates the object that represents the walls of a 3-D chart.

class Walls extends Floor;

Constructors

ConstructorDescription
constructor(Floor)Constructs from a parent object convertible to this.

Properties

PropertyTypeDescription
centerXnumberReadonly. 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.
centerYnumberReadonly. 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.
widthnumberReadonly. Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
depthnumberReadonly. Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
heightnumberReadonly. Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method.
centerXPxnumberReadonly. Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
centerYPxnumberReadonly. Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
widthPxnumberReadonly. Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
depthPxnumberReadonly. Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
heightPxnumberReadonly. Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
backgroundColorColorGets or sets the background Color of the Area.
foregroundColorColorGets or sets the foreground Color.
formattingFormattingTypeRepresents the formatting of the area.
invertIfNegativebooleanIf the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
fillFormatFillFormatReadonly. Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
transparencynumberReturns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
borderLineGets or sets the border Line.

Methods

MethodDescription
getCenterX()@deprecated. Please use the ‘centerX’ property instead. 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()@deprecated. Please use the ‘centerY’ property instead. 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()@deprecated. Please use the ‘width’ property instead. Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
getDepth()@deprecated. Please use the ‘depth’ property instead. Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method.
getHeight()@deprecated. Please use the ‘height’ property instead. Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method.
getCenterXPx()@deprecated. Please use the ‘centerXPx’ property instead. Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
getCenterYPx()@deprecated. Please use the ‘centerYPx’ property instead. Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
getWidthPx()@deprecated. Please use the ‘widthPx’ property instead. Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
getDepthPx()@deprecated. Please use the ‘depthPx’ property instead. Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
getHeightPx()@deprecated. Please use the ‘heightPx’ property instead. 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()@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.
setBackgroundColor(Color)@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.
getForegroundColor()@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.
setForegroundColor(Color)@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.
getFormatting()@deprecated. Please use the ‘formatting’ property instead. Represents the formatting of the area.
setFormatting(FormattingType)@deprecated. Please use the ‘formatting’ property instead. Represents the formatting of the area.
getInvertIfNegative()@deprecated. Please use the ‘invertIfNegative’ property instead. 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)@deprecated. Please use the ‘invertIfNegative’ property instead. 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()@deprecated. Please use the ‘fillFormat’ property instead. Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
getTransparency()@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(number)@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
getBorder()@deprecated. Please use the ‘border’ property instead. Gets or sets the border Line.
setBorder(Line)@deprecated. Please use the ‘border’ property instead. Gets or sets the border Line.

constructor(Floor)

Constructs from a parent object convertible to this.

constructor(obj: Floor);

Parameters:

ParameterTypeDescription
objFloorThe parent object.

centerX

Readonly. 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.

centerX : number;

centerY

Readonly. 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.

centerY : number;

width

Readonly. Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method.

width : number;

depth

Readonly. Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method.

depth : number;

height

Readonly. Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method.

height : number;

centerXPx

Readonly. Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.

centerXPx : number;

centerYPx

Readonly. Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.

centerYPx : number;

widthPx

Readonly. Gets the width of left to right in units of pixels after calls Chart.Calculate() method.

widthPx : number;

depthPx

Readonly. Gets the depth front to back in units of pixels after calls Chart.Calculate() method.

depthPx : number;

heightPx

Readonly. Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.

heightPx : number;

backgroundColor

Gets or sets the background Color of the Area.

backgroundColor : Color;

foregroundColor

Gets or sets the foreground Color.

foregroundColor : Color;

formatting

Represents the formatting of the area.

formatting : FormattingType;

invertIfNegative

If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.

invertIfNegative : boolean;

fillFormat

Readonly. Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.

fillFormat : FillFormat;

transparency

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

transparency : number;

border

Gets or sets the border Line.

border : Line;

getCenterX()

@deprecated. Please use the ‘centerX’ property instead. 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()

@deprecated. Please use the ‘centerY’ property instead. 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()

@deprecated. Please use the ‘width’ property instead. Gets the width of left to right in units of 1/4000 of chart’s width after calls Chart.Calculate() method.

getWidth() : number;

getDepth()

@deprecated. Please use the ‘depth’ property instead. Gets the depth front to back in units of 1/4000 of chart’s width after calls Chart.Calculate() method.

getDepth() : number;

getHeight()

@deprecated. Please use the ‘height’ property instead. Gets the height of top to bottom in units of 1/4000 of chart’s height after calls Chart.Calculate() method.

getHeight() : number;

getCenterXPx()

@deprecated. Please use the ‘centerXPx’ property instead. Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.

getCenterXPx() : number;

getCenterYPx()

@deprecated. Please use the ‘centerYPx’ property instead. Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.

getCenterYPx() : number;

getWidthPx()

@deprecated. Please use the ‘widthPx’ property instead. Gets the width of left to right in units of pixels after calls Chart.Calculate() method.

getWidthPx() : number;

getDepthPx()

@deprecated. Please use the ‘depthPx’ property instead. Gets the depth front to back in units of pixels after calls Chart.Calculate() method.

getDepthPx() : number;

getHeightPx()

@deprecated. Please use the ‘heightPx’ property instead. 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:

ParameterTypeDescription
indexnumber

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:

ParameterTypeDescription
indexnumber

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getBackgroundColor()

@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.

getBackgroundColor() : Color;

Returns

Color

setBackgroundColor(Color)

@deprecated. Please use the ‘backgroundColor’ property instead. Gets or sets the background Color of the Area.

setBackgroundColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getForegroundColor()

@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.

getForegroundColor() : Color;

Returns

Color

setForegroundColor(Color)

@deprecated. Please use the ‘foregroundColor’ property instead. Gets or sets the foreground Color.

setForegroundColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getFormatting()

@deprecated. Please use the ‘formatting’ property instead. Represents the formatting of the area.

getFormatting() : FormattingType;

Returns

FormattingType

setFormatting(FormattingType)

@deprecated. Please use the ‘formatting’ property instead. Represents the formatting of the area.

setFormatting(value: FormattingType) : void;

Parameters:

ParameterTypeDescription
valueFormattingTypeThe value to set.

getInvertIfNegative()

@deprecated. Please use the ‘invertIfNegative’ property instead. 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)

@deprecated. Please use the ‘invertIfNegative’ property instead. 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:

ParameterTypeDescription
valuebooleanThe value to set.

getFillFormat()

@deprecated. Please use the ‘fillFormat’ property instead. Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.

getFillFormat() : FillFormat;

Returns

FillFormat

getTransparency()

@deprecated. Please use the ’transparency’ property instead. 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)

@deprecated. Please use the ’transparency’ property instead. 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:

ParameterTypeDescription
valuenumberThe value to set.

getBorder()

@deprecated. Please use the ‘border’ property instead. Gets or sets the border Line.

getBorder() : Line;

Returns

Line

setBorder(Line)

@deprecated. Please use the ‘border’ property instead. Gets or sets the border Line.

setBorder(value: Line) : void;

Parameters:

ParameterTypeDescription
valueLineThe value to set.