Class ChartFrame

Namespace: Aspose.Cells.Charts
Assembly: Aspose.Cells.dll (25.3.0)

Encapsulates the object that represents the frame object in a chart.

public class ChartFrame

Inheritance

object ← ChartFrame

Derived

ChartArea, ChartTextFrame, PlotArea

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Fields

m_AutoScaleFont

protected bool m_AutoScaleFont

Field Value

bool

m_BackgroundMode

protected BackgroundMode m_BackgroundMode

Field Value

BackgroundMode

m_IsAutoXPos

protected bool m_IsAutoXPos

Field Value

bool

m_IsAutoYPos

protected bool m_IsAutoYPos

Field Value

bool

m_IsOffsetPosBeSet

protected bool m_IsOffsetPosBeSet

Field Value

bool

m_fontIndex

protected int m_fontIndex

Field Value

int

m_isAutoSize

protected bool m_isAutoSize

Field Value

bool

Properties

Area

Gets the Aspose.Cells.Charts.ChartFrame.Area?text=area.

public virtual Area Area { get; }

Property Value

Area

AutoScaleFont

True if the text in the object changes font size when the object size changes. The default value is True.

public virtual bool AutoScaleFont { get; set; }

Property Value

bool

BackgroundMode

Gets and sets the display mode of the background

public BackgroundMode BackgroundMode { get; set; }

Property Value

BackgroundMode

Border

Gets the Aspose.Cells.Drawing.Line?text=border.

public virtual Line Border { get; }

Property Value

Line

DefaultHeightRatioToChart

Represents height of default position in units of Fraction of the chart area.

public double DefaultHeightRatioToChart { get; }

Property Value

double

DefaultWidthRatioToChart

Represents width of default position in units of Fraction of the chart area.

public double DefaultWidthRatioToChart { get; }

Property Value

double

DefaultXRatioToChart

Represents x of default position in units of Fraction of the chart area.

public double DefaultXRatioToChart { get; }

Property Value

double

DefaultYRatioToChart

Represents y of default position in units of Fraction of the chart area.

public double DefaultYRatioToChart { get; }

Property Value

double

Font

Gets a Aspose.Cells.Charts.ChartFrame.Font object of the specified ChartFrame object.

public virtual Font Font { get; }

Property Value

Font

HeightPixel

Gets or sets the height of frame in units of Pixel.

public virtual int HeightPixel { get; set; }

Property Value

int

HeightRatioToChart

Gets or sets the height of frame in units of ratio of the chart area.

public virtual double HeightRatioToChart { get; set; }

Property Value

double

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;

IsAutomaticSize

Indicates whether the chart frame is automatic sized.

public virtual bool IsAutomaticSize { get; set; }

Property Value

bool

IsDefaultPosBeSet

Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

public bool IsDefaultPosBeSet { get; }

Property Value

bool

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.

public bool IsInnerMode { get; set; }

Property Value

bool

Remarks

Only for Xlsx file.

Shadow

True if the frame has a shadow.

public bool Shadow { get; set; }

Property Value

bool

ShapeProperties

Gets the Aspose.Cells.Charts.ChartFrame.ShapeProperties object.

public ShapePropertyCollection ShapeProperties { get; }

Property Value

ShapePropertyCollection

TextOptions

Gets and sets the options of the text.

public virtual TextOptions TextOptions { get; }

Property Value

TextOptions

WidthPixel

Gets or sets the width of frame in units of Pixel.

public virtual int WidthPixel { get; set; }

Property Value

int

WidthRatioToChart

Gets or sets the width of frame in units of ratio of the chart area.

public virtual double WidthRatioToChart { get; set; }

Property Value

double

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;

XPixel

Gets or sets the x coordinate of the upper left corner in units of Pixel.

public virtual int XPixel { get; set; }

Property Value

int

XRatioToChart

Gets or sets the x coordinate of the upper left corner in units of ratio of the chart area.

public virtual double XRatioToChart { get; set; }

Property Value

double

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;

YPixel

Gets or sets the y coordinate of the upper left corner in units of Pixel.

public virtual int YPixel { get; set; }

Property Value

int

YRatioToChart

Gets or sets the y coordinate of the upper left corner in units of ratio of the chart area.

public virtual double YRatioToChart { get; set; }

Property Value

double

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;

Methods

SetPositionAuto()

Set position of the frame to automatic

public virtual void SetPositionAuto()