ChartFrame
ChartFrame class
Encapsulates the object that represents the frame object in a chart.
class ChartFrame;
Properties
Property | Type | Description |
---|---|---|
isInnerMode | 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. |
backgroundMode | BackgroundMode | Gets and sets the display mode of the background |
shadow | boolean | True if the frame has a shadow. |
shapeProperties | ShapePropertyCollection | Readonly. Gets the ShapeProperties object. |
isDefaultPosBeSet | boolean | Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
defaultX | number | Readonly. Represents x of default position in units of 1/4000 of the chart area. |
defaultY | number | Readonly. Represents y of default position in units of 1/4000 of the chart area. |
defaultWidth | number | Readonly. Represents width of default position in units of 1/4000 of the chart area. |
defaultHeight | number | Readonly. Represents height of default position in units of 1/4000 of the chart area. |
defaultXRatioToChart | number | Readonly. Represents x of default position in units of Fraction of the chart area. |
defaultYRatioToChart | number | Readonly. Represents y of default position in units of Fraction of the chart area. |
defaultWidthRatioToChart | number | Readonly. Represents width of default position in units of Fraction of the chart area. |
defaultHeightRatioToChart | number | Readonly. Represents height of default position in units of Fraction of the chart area. |
Methods
Method | Description |
---|---|
isInnerMode() | @deprecated. Please use the ‘isInnerMode’ property instead. 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) | @deprecated. Please use the ‘isInnerMode’ property instead. 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() | @deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background |
setBackgroundMode(BackgroundMode) | @deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background |
getShadow() | @deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow. |
setShadow(boolean) | @deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow. |
getShapeProperties() | @deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapeProperties object. |
isDefaultPosBeSet() | @deprecated. Please use the ‘isDefaultPosBeSet’ property instead. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
getDefaultX() | @deprecated. Please use the ‘defaultX’ property instead. Represents x of default position in units of 1/4000 of the chart area. |
getDefaultY() | @deprecated. Please use the ‘defaultY’ property instead. Represents y of default position in units of 1/4000 of the chart area. |
getDefaultWidth() | @deprecated. Please use the ‘defaultWidth’ property instead. Represents width of default position in units of 1/4000 of the chart area. |
getDefaultHeight() | @deprecated. Please use the ‘defaultHeight’ property instead. Represents height of default position in units of 1/4000 of the chart area. |
getDefaultXRatioToChart() | @deprecated. Please use the ‘defaultXRatioToChart’ property instead. Represents x of default position in units of Fraction of the chart area. |
getDefaultYRatioToChart() | @deprecated. Please use the ‘defaultYRatioToChart’ property instead. Represents y of default position in units of Fraction of the chart area. |
getDefaultWidthRatioToChart() | @deprecated. Please use the ‘defaultWidthRatioToChart’ property instead. Represents width of default position in units of Fraction of the chart area. |
getDefaultHeightRatioToChart() | @deprecated. Please use the ‘defaultHeightRatioToChart’ property instead. Represents height of default position in units of Fraction of the chart area. |
isNull() | Checks whether the implementation object is null. |
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. |
getXRatioToChart() | Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area. |
setXRatioToChart(number) | Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area. |
getYRatioToChart() | Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area. |
setYRatioToChart(number) | Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area. |
getWidthRatioToChart() | Gets or sets the width of frame in units of ratio of the chart area. |
setWidthRatioToChart(number) | Gets or sets the width of frame in units of ratio of the chart area. |
getHeightRatioToChart() | Gets or sets the height of frame in units of ratio of the chart area. |
setHeightRatioToChart(number) | Gets or sets the height of frame in units of ratio of the chart area. |
getXPixel() | Gets or sets the x coordinate of the upper left corner in units of Pixel. |
setXPixel(number) | Gets or sets the x coordinate of the upper left corner in units of Pixel. |
getYPixel() | Gets or sets the y coordinate of the upper left corner in units of Pixel. |
setYPixel(number) | Gets or sets the y coordinate of the upper left corner in units of Pixel. |
getWidthPixel() | Gets or sets the width of frame in units of Pixel. |
setWidthPixel(number) | Gets or sets the width of frame in units of Pixel. |
getHeightPixel() | Gets or sets the height of frame in units of Pixel. |
setHeightPixel(number) | Gets or sets the height of frame in units of Pixel. |
setPositionAuto() | Set position of the frame to automatic |
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.
backgroundMode
Gets and sets the display mode of the background
backgroundMode : BackgroundMode;
shadow
True if the frame has a shadow.
shadow : boolean;
shapeProperties
Readonly. Gets the ShapeProperties object.
shapeProperties : ShapePropertyCollection;
isDefaultPosBeSet
Readonly. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
isDefaultPosBeSet : boolean;
defaultX
Readonly. Represents x of default position in units of 1/4000 of the chart area.
defaultX : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultXRatioToChart property, instead. DefaultX = (int)(DefaultXRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
defaultY
Readonly. Represents y of default position in units of 1/4000 of the chart area.
defaultY : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultYRatioToChart property, instead. DefaultY = (int)(DefaultYRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
defaultWidth
Readonly. Represents width of default position in units of 1/4000 of the chart area.
defaultWidth : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultWidthRatioToChart property, instead. DefaultWidth = (int)(DefaultWidthRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
defaultHeight
Readonly. Represents height of default position in units of 1/4000 of the chart area.
defaultHeight : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultHeightRatioToChart property, instead. DefaultHeight = (int)(DefaultHeightRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
defaultXRatioToChart
Readonly. Represents x of default position in units of Fraction of the chart area.
defaultXRatioToChart : number;
defaultYRatioToChart
Readonly. Represents y of default position in units of Fraction of the chart area.
defaultYRatioToChart : number;
defaultWidthRatioToChart
Readonly. Represents width of default position in units of Fraction of the chart area.
defaultWidthRatioToChart : number;
defaultHeightRatioToChart
Readonly. Represents height of default position in units of Fraction of the chart area.
defaultHeightRatioToChart : number;
isInnerMode()
@deprecated. Please use the ‘isInnerMode’ property instead. 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)
@deprecated. Please use the ‘isInnerMode’ property instead. 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()
@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
getBackgroundMode() : BackgroundMode;
Returns
setBackgroundMode(BackgroundMode)
@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background
setBackgroundMode(value: BackgroundMode) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | BackgroundMode | The value to set. |
getShadow()
@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.
getShadow() : boolean;
setShadow(boolean)
@deprecated. Please use the ‘shadow’ property instead. True if the frame has a shadow.
setShadow(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShapeProperties()
@deprecated. Please use the ‘shapeProperties’ property instead. Gets the ShapeProperties object.
getShapeProperties() : ShapePropertyCollection;
Returns
isDefaultPosBeSet()
@deprecated. Please use the ‘isDefaultPosBeSet’ property instead. Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
isDefaultPosBeSet() : boolean;
getDefaultX()
@deprecated. Please use the ‘defaultX’ property instead. Represents x of default position in units of 1/4000 of the chart area.
getDefaultX() : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultXRatioToChart property, instead. DefaultX = (int)(DefaultXRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
getDefaultY()
@deprecated. Please use the ‘defaultY’ property instead. Represents y of default position in units of 1/4000 of the chart area.
getDefaultY() : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultYRatioToChart property, instead. DefaultY = (int)(DefaultYRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
getDefaultWidth()
@deprecated. Please use the ‘defaultWidth’ property instead. Represents width of default position in units of 1/4000 of the chart area.
getDefaultWidth() : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultWidthRatioToChart property, instead. DefaultWidth = (int)(DefaultWidthRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
getDefaultHeight()
@deprecated. Please use the ‘defaultHeight’ property instead. Represents height of default position in units of 1/4000 of the chart area.
getDefaultHeight() : number;
Remarks
NOTE: This member is now obsolete. Please use ChartFrame.DefaultHeightRatioToChart property, instead. DefaultHeight = (int)(DefaultHeightRatioToChart * 4000); This property will be removed 12 months later since February 2025. Aspose apologizes for any inconvenience you may have experienced.
getDefaultXRatioToChart()
@deprecated. Please use the ‘defaultXRatioToChart’ property instead. Represents x of default position in units of Fraction of the chart area.
getDefaultXRatioToChart() : number;
getDefaultYRatioToChart()
@deprecated. Please use the ‘defaultYRatioToChart’ property instead. Represents y of default position in units of Fraction of the chart area.
getDefaultYRatioToChart() : number;
getDefaultWidthRatioToChart()
@deprecated. Please use the ‘defaultWidthRatioToChart’ property instead. Represents width of default position in units of Fraction of the chart area.
getDefaultWidthRatioToChart() : number;
getDefaultHeightRatioToChart()
@deprecated. Please use the ‘defaultHeightRatioToChart’ property instead. Represents height of default position in units of Fraction of the chart area.
getDefaultHeightRatioToChart() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
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 / 4000d;
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 / 4000d;
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 / 4000d;
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 / 4000d;
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 / 4000d;
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 / 4000d;
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 / 4000d;
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 / 4000d;
getXRatioToChart()
Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area.
getXRatioToChart() : number;
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? XPixel = XRatioToChart * Chart.ChartObject.Width;
setXRatioToChart(number)
Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area.
setXRatioToChart(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? XPixel = XRatioToChart * Chart.ChartObject.Width;
getYRatioToChart()
Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area.
getYRatioToChart() : number;
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? YPixel = YRatioToChart * Chart.ChartObject.Height;
setYRatioToChart(number)
Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area.
setYRatioToChart(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? YPixel = YRatioToChart * Chart.ChartObject.Height;
getWidthRatioToChart()
Gets or sets the width of frame in units of ratio of the chart area.
getWidthRatioToChart() : number;
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? WidthPixel = WidthRatioToChart * Chart.ChartObject.Width;
setWidthRatioToChart(number)
Gets or sets the width of frame in units of ratio of the chart area.
setWidthRatioToChart(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? WidthPixel = WidthRatioToChart * Chart.ChartObject.Width;
getHeightRatioToChart()
Gets or sets the height of frame in units of ratio of the chart area.
getHeightRatioToChart() : number;
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? HeightPixel = HeightRatioToChart * Chart.ChartObject.Height;
setHeightRatioToChart(number)
Gets or sets the height of frame in units of ratio of the chart area.
setHeightRatioToChart(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
Remarks
This is a fraction value, its valid range is between 0-1. How to convert units of ratio to pixels? HeightPixel = HeightRatioToChart * Chart.ChartObject.Height;
getXPixel()
Gets or sets the x coordinate of the upper left corner in units of Pixel.
getXPixel() : number;
setXPixel(number)
Gets or sets the x coordinate of the upper left corner in units of Pixel.
setXPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getYPixel()
Gets or sets the y coordinate of the upper left corner in units of Pixel.
getYPixel() : number;
setYPixel(number)
Gets or sets the y coordinate of the upper left corner in units of Pixel.
setYPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getWidthPixel()
Gets or sets the width of frame in units of Pixel.
getWidthPixel() : number;
setWidthPixel(number)
Gets or sets the width of frame in units of Pixel.
setWidthPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getHeightPixel()
Gets or sets the height of frame in units of Pixel.
getHeightPixel() : number;
setHeightPixel(number)
Gets or sets the height of frame in units of Pixel.
setHeightPixel(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
setPositionAuto()
Set position of the frame to automatic
setPositionAuto() : void;