ShadowEffect
ShadowEffect class
This class specifies the shadow effect of the chart element or shape.
class ShadowEffect;
Properties
| Property | Type | Description |
|---|---|---|
| presetType | PresetShadowType | Gets and sets the preset shadow type of the shadow. |
| color | CellsColor | Gets and sets the color of the shadow. |
| transparency | number | Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). |
| size | number | Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow. |
| blur | number | Gets and sets the blur of the shadow. Range from 0 to 100 points. |
| angle | number | Gets and sets the lighting angle. Range from 0 to 359.9 degrees. |
| distance | number | Gets and sets the distance of the shadow. Range from 0 to 200 points. |
Methods
| Method | Description |
|---|---|
| getPresetType() | @deprecated. Please use the ‘presetType’ property instead. Gets and sets the preset shadow type of the shadow. |
| setPresetType(PresetShadowType) | @deprecated. Please use the ‘presetType’ property instead. Gets and sets the preset shadow type of the shadow. |
| getColor() | @deprecated. Please use the ‘color’ property instead. Gets and sets the color of the shadow. |
| setColor(CellsColor) | @deprecated. Please use the ‘color’ property instead. Gets and sets the color of the shadow. |
| getTransparency() | @deprecated. Please use the ’transparency’ property instead. Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). |
| setTransparency(number) | @deprecated. Please use the ’transparency’ property instead. Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear). |
| getSize() | @deprecated. Please use the ‘size’ property instead. Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow. |
| setSize(number) | @deprecated. Please use the ‘size’ property instead. Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow. |
| getBlur() | @deprecated. Please use the ‘blur’ property instead. Gets and sets the blur of the shadow. Range from 0 to 100 points. |
| setBlur(number) | @deprecated. Please use the ‘blur’ property instead. Gets and sets the blur of the shadow. Range from 0 to 100 points. |
| getAngle() | @deprecated. Please use the ‘angle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees. |
| setAngle(number) | @deprecated. Please use the ‘angle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees. |
| getDistance() | @deprecated. Please use the ‘distance’ property instead. Gets and sets the distance of the shadow. Range from 0 to 200 points. |
| setDistance(number) | @deprecated. Please use the ‘distance’ property instead. Gets and sets the distance of the shadow. Range from 0 to 200 points. |
| isNull() | Checks whether the implementation object is null. |
presetType
Gets and sets the preset shadow type of the shadow.
presetType : PresetShadowType;
color
Gets and sets the color of the shadow.
color : CellsColor;
transparency
Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).
transparency : number;
size
Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow.
size : number;
blur
Gets and sets the blur of the shadow. Range from 0 to 100 points.
blur : number;
angle
Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
angle : number;
distance
Gets and sets the distance of the shadow. Range from 0 to 200 points.
distance : number;
getPresetType()
@deprecated. Please use the ‘presetType’ property instead. Gets and sets the preset shadow type of the shadow.
getPresetType() : PresetShadowType;
Returns
setPresetType(PresetShadowType)
@deprecated. Please use the ‘presetType’ property instead. Gets and sets the preset shadow type of the shadow.
setPresetType(value: PresetShadowType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PresetShadowType | The value to set. |
getColor()
@deprecated. Please use the ‘color’ property instead. Gets and sets the color of the shadow.
getColor() : CellsColor;
Returns
setColor(CellsColor)
@deprecated. Please use the ‘color’ property instead. Gets and sets the color of the shadow.
setColor(value: CellsColor) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CellsColor | The value to set. |
getTransparency()
@deprecated. Please use the ’transparency’ property instead. Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).
getTransparency() : number;
setTransparency(number)
@deprecated. Please use the ’transparency’ property instead. Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).
setTransparency(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getSize()
@deprecated. Please use the ‘size’ property instead. Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow.
getSize() : number;
setSize(number)
@deprecated. Please use the ‘size’ property instead. Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow.
setSize(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getBlur()
@deprecated. Please use the ‘blur’ property instead. Gets and sets the blur of the shadow. Range from 0 to 100 points.
getBlur() : number;
setBlur(number)
@deprecated. Please use the ‘blur’ property instead. Gets and sets the blur of the shadow. Range from 0 to 100 points.
setBlur(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getAngle()
@deprecated. Please use the ‘angle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
getAngle() : number;
setAngle(number)
@deprecated. Please use the ‘angle’ property instead. Gets and sets the lighting angle. Range from 0 to 359.9 degrees.
setAngle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getDistance()
@deprecated. Please use the ‘distance’ property instead. Gets and sets the distance of the shadow. Range from 0 to 200 points.
getDistance() : number;
setDistance(number)
@deprecated. Please use the ‘distance’ property instead. Gets and sets the distance of the shadow. Range from 0 to 200 points.
setDistance(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;