ChartFrame
ChartFrame class
Encapsulates the object that represents the frame object in a chart.
class ChartFrame;
Methods
| Method | Description |
|---|---|
| isInnerMode() | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
| setIsInnerMode(boolean) | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. |
| getBackgroundMode() | Gets and sets the display mode of the background |
| setBackgroundMode(BackgroundMode) | Gets and sets the display mode of the background |
| getShadow() | True if the frame has a shadow. |
| setShadow(boolean) | True if the frame has a shadow. |
| getShapeProperties() | Gets the ShapeProperties object. |
| isDefaultPosBeSet() | Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
| getDefaultX() | Represents x of default position |
| getDefaultY() | Represents y of default position |
| getDefaultWidth() | Represents width of default position |
| getDefaultHeight() | Represents height of default position |
| setPositionAuto() | Set position of the frame to automatic |
| getBorder() | Gets the |
| getArea() | Gets the |
| getTextOptions() | Gets and sets the options of the text. |
| getFont() | Gets a Font object of the specified ChartFrame object. |
| getAutoScaleFont() | True if the text in the object changes font size when the object size changes. The default value is True. |
| setAutoScaleFont(boolean) | True if the text in the object changes font size when the object size changes. The default value is True. |
| isAutomaticSize() | Indicates whether the chart frame is automatic sized. |
| setIsAutomaticSize(boolean) | Indicates whether the chart frame is automatic sized. |
| getX() | Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. |
| setX(number) | Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. |
| getY() | Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
| setY(number) | Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
| getHeight() | Gets or sets the height of frame in units of 1/4000 of the chart area. |
| setHeight(number) | Gets or sets the height of frame in units of 1/4000 of the chart area. |
| getWidth() | Gets or sets the width of frame in units of 1/4000 of the chart area. |
| setWidth(number) | Gets or sets the width of frame in units of 1/4000 of the chart area. |
isInnerMode()
Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
isInnerMode() : boolean;
Remarks
Only for Xlsx file.
setIsInnerMode(boolean)
Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
setIsInnerMode(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only for Xlsx file.
getBackgroundMode()
Gets and sets the display mode of the background
getBackgroundMode() : BackgroundMode;
Returns
setBackgroundMode(BackgroundMode)
Gets and sets the display mode of the background
setBackgroundMode(value: BackgroundMode) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BackgroundMode | The value to set. |
getShadow()
True if the frame has a shadow.
getShadow() : boolean;
setShadow(boolean)
True if the frame has a shadow.
setShadow(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShapeProperties()
Gets the ShapeProperties object.
getShapeProperties() : ShapePropertyCollection;
Returns
isDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
isDefaultPosBeSet() : boolean;
getDefaultX()
Represents x of default position
getDefaultX() : number;
getDefaultY()
Represents y of default position
getDefaultY() : number;
getDefaultWidth()
Represents width of default position
getDefaultWidth() : number;
getDefaultHeight()
Represents height of default position
getDefaultHeight() : number;
setPositionAuto()
Set position of the frame to automatic
setPositionAuto() : void;
getBorder()
Gets the
getBorder() : Line;
Returns
getArea()
Gets the
getArea() : Area;
Returns
getTextOptions()
Gets and sets the options of the text.
getTextOptions() : TextOptions;
Returns
getFont()
Gets a Font object of the specified ChartFrame object.
getFont() : Font;
Returns
getAutoScaleFont()
True if the text in the object changes font size when the object size changes. The default value is True.
getAutoScaleFont() : boolean;
setAutoScaleFont(boolean)
True if the text in the object changes font size when the object size changes. The default value is True.
setAutoScaleFont(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isAutomaticSize()
Indicates whether the chart frame is automatic sized.
isAutomaticSize() : boolean;
setIsAutomaticSize(boolean)
Indicates whether the chart frame is automatic sized.
setIsAutomaticSize(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getX()
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
getX() : number;
Remarks
How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
setX(number)
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
setX(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
getY()
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
getY() : number;
Remarks
How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
setY(number)
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
setY(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
getHeight()
Gets or sets the height of frame in units of 1/4000 of the chart area.
getHeight() : number;
Remarks
How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
setHeight(number)
Gets or sets the height of frame in units of 1/4000 of the chart area.
setHeight(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
getWidth()
Gets or sets the width of frame in units of 1/4000 of the chart area.
getWidth() : number;
Remarks
How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;
setWidth(number)
Gets or sets the width of frame in units of 1/4000 of the chart area.
setWidth(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;