DataLabels
DataLabels class
Encapsulates a collection of all the DataLabel objects for the specified Series.
class DataLabels extends ChartTextFrame;
Example
const { Workbook, ChartType, LabelPositionType } = require("aspose.cells.node");
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(4);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(20);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 25, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Set the DataLabels in the chart
var datalabels;
for (var i = 0; i < chart.nSeries.count; i++) {
datalabels = chart.nSeries.get(i).dataLabels;
//Set the position of DataLabels
datalabels.position = LabelPositionType.InsideBase;
//Show the category name in the DataLabels
datalabels.setCategoryNameShown(true);
//Show the value in the DataLabels
datalabels.showValue = true;
//Not show the percentage in the DataLabels
datalabels.setPercentageShown(false);
//Not show the legend key.
datalabels.setLegendKeyShown(false);
}
Constructors
Constructor | Description |
---|---|
constructor(ChartTextFrame) | Constructs from a parent object convertible to this. |
Properties
Property | Type | Description |
---|---|---|
border | Line | Readonly. Gets the |
area | Area | Readonly. Gets the |
isAutoText | boolean | Indicates the text is auto generated. |
directionType | ChartTextDirectionType | Gets and sets the direction of text. |
text | string | Gets or sets the text of data label. |
isTextWrapped | boolean | Gets or sets a value indicating whether the text is wrapped. |
backgroundMode | BackgroundMode | Gets and sets the display mode of the background |
showValue | boolean | Represents a specified chart’s data label values display behavior. True displays the values. False to hide. |
showCellRange | boolean | Indicates whether showing cell range as the data labels. |
showPercentage | boolean | Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
showBubbleSize | boolean | Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
showCategoryName | boolean | Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide. |
showSeriesName | boolean | Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide. |
showLegendKey | boolean | Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible. |
numberFormat | string | Represents the format string for the DataLabels object. |
number | number | Gets and sets the built-in number format. |
numberFormatLinked | boolean | True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
font | Font | Readonly. Gets the font of the DataLabels; |
separatorType | DataLabelsSeparatorType | Gets or sets the separator type used for the data labels on a chart. |
separatorValue | string | Gets or sets the separator value used for the data labels on a chart. |
position | LabelPositionType | Represents the position of the data label. |
isNeverOverlap | boolean | Indicates whether the datalabels display never overlap. (For Pie chart) |
shapeType | DataLabelShapeType | Gets or sets shape type of data label. |
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. |
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. |
isDeleted | boolean | Indicates whether this data labels is deleted. |
textHorizontalAlignment | TextAlignmentType | Gets and sets the text horizontal alignment. |
textVerticalAlignment | TextAlignmentType | Gets or sets the text vertical alignment of text. |
rotationAngle | number | Represents text rotation angle. |
isAutomaticRotation | boolean | Readonly. Indicates whether the text of the chart is automatically rotated. |
readingOrder | TextDirectionType | Represents text reading order. |
isResizeShapeToFitText | boolean | Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside. |
Methods
Method | Description |
---|---|
getBorder() | @deprecated. Please use the ‘border’ property instead. Gets the |
getArea() | @deprecated. Please use the ‘area’ property instead. Gets the |
isAutoText() | @deprecated. Please use the ‘isAutoText’ property instead. Indicates the text is auto generated. |
setIsAutoText(boolean) | @deprecated. Please use the ‘isAutoText’ property instead. Indicates the text is auto generated. |
getDirectionType() | @deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text. |
setDirectionType(ChartTextDirectionType) | @deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text. |
getText() | @deprecated. Please use the ’text’ property instead. Gets or sets the text of data label. |
setText(string) | @deprecated. Please use the ’text’ property instead. Gets or sets the text of data label. |
isTextWrapped() | @deprecated. Please use the ‘isTextWrapped’ property instead. Gets or sets a value indicating whether the text is wrapped. |
setIsTextWrapped(boolean) | @deprecated. Please use the ‘isTextWrapped’ property instead. Gets or sets a value indicating whether the text is wrapped. |
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 |
getShowValue() | @deprecated. Please use the ‘showValue’ property instead. Represents a specified chart’s data label values display behavior. True displays the values. False to hide. |
setShowValue(boolean) | @deprecated. Please use the ‘showValue’ property instead. Represents a specified chart’s data label values display behavior. True displays the values. False to hide. |
getShowCellRange() | @deprecated. Please use the ‘showCellRange’ property instead. Indicates whether showing cell range as the data labels. |
setShowCellRange(boolean) | @deprecated. Please use the ‘showCellRange’ property instead. Indicates whether showing cell range as the data labels. |
getShowPercentage() | @deprecated. Please use the ‘showPercentage’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
setShowPercentage(boolean) | @deprecated. Please use the ‘showPercentage’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
getShowBubbleSize() | @deprecated. Please use the ‘showBubbleSize’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
setShowBubbleSize(boolean) | @deprecated. Please use the ‘showBubbleSize’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide. |
getShowCategoryName() | @deprecated. Please use the ‘showCategoryName’ property instead. Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide. |
setShowCategoryName(boolean) | @deprecated. Please use the ‘showCategoryName’ property instead. Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide. |
getShowSeriesName() | @deprecated. Please use the ‘showSeriesName’ property instead. Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide. |
setShowSeriesName(boolean) | @deprecated. Please use the ‘showSeriesName’ property instead. Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide. |
getShowLegendKey() | @deprecated. Please use the ‘showLegendKey’ property instead. Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible. |
setShowLegendKey(boolean) | @deprecated. Please use the ‘showLegendKey’ property instead. Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible. |
get_NumberFormat() | @deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the DataLabels object. |
setNumberFormat(string) | @deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the DataLabels object. |
getNumber() | @deprecated. Please use the ’number’ property instead. Gets and sets the built-in number format. |
setNumber(number) | @deprecated. Please use the ’number’ property instead. Gets and sets the built-in number format. |
getNumberFormatLinked() | @deprecated. Please use the ’numberFormatLinked’ property instead. True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
setNumberFormatLinked(boolean) | @deprecated. Please use the ’numberFormatLinked’ property instead. True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
getFont() | @deprecated. Please use the ‘font’ property instead. Gets the font of the DataLabels; |
getSeparatorType() | @deprecated. Please use the ‘separatorType’ property instead. Gets or sets the separator type used for the data labels on a chart. |
setSeparatorType(DataLabelsSeparatorType) | @deprecated. Please use the ‘separatorType’ property instead. Gets or sets the separator type used for the data labels on a chart. |
getSeparatorValue() | @deprecated. Please use the ‘separatorValue’ property instead. Gets or sets the separator value used for the data labels on a chart. |
setSeparatorValue(string) | @deprecated. Please use the ‘separatorValue’ property instead. Gets or sets the separator value used for the data labels on a chart. |
getPosition() | @deprecated. Please use the ‘position’ property instead. Represents the position of the data label. |
setPosition(LabelPositionType) | @deprecated. Please use the ‘position’ property instead. Represents the position of the data label. |
isNeverOverlap() | @deprecated. Please use the ‘isNeverOverlap’ property instead. Indicates whether the datalabels display never overlap. (For Pie chart) |
setIsNeverOverlap(boolean) | @deprecated. Please use the ‘isNeverOverlap’ property instead. Indicates whether the datalabels display never overlap. (For Pie chart) |
getShapeType() | @deprecated. Please use the ‘shapeType’ property instead. Gets or sets shape type of data label. |
setShapeType(DataLabelShapeType) | @deprecated. Please use the ‘shapeType’ property instead. Gets or sets shape type of data label. |
applyFont() | Apply the font of the datalabels to all child nodes. |
isNull() | Checks whether the implementation object is null. |
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. |
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. |
isDeleted() | @deprecated. Please use the ‘isDeleted’ property instead. Indicates whether this data labels is deleted. |
setIsDeleted(boolean) | @deprecated. Please use the ‘isDeleted’ property instead. Indicates whether this data labels is deleted. |
getTextHorizontalAlignment() | @deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment. |
setTextHorizontalAlignment(TextAlignmentType) | @deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment. |
getTextVerticalAlignment() | @deprecated. Please use the ’textVerticalAlignment’ property instead. Gets or sets the text vertical alignment of text. |
setTextVerticalAlignment(TextAlignmentType) | @deprecated. Please use the ’textVerticalAlignment’ property instead. Gets or sets the text vertical alignment of text. |
getRotationAngle() | @deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle. |
setRotationAngle(number) | @deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle. |
isAutomaticRotation() | @deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the text of the chart is automatically rotated. |
getReadingOrder() | @deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order. |
setReadingOrder(TextDirectionType) | @deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order. |
isResizeShapeToFitText() | @deprecated. Please use the ‘isResizeShapeToFitText’ property instead. Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside. |
setIsResizeShapeToFitText(boolean) | @deprecated. Please use the ‘isResizeShapeToFitText’ property instead. Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside. |
characters(number, number) | Returns a Characters object that represents a range of characters within the text. |
getTextOptions() | Gets and sets the options of the text. |
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 |
getLinkedSource() | Gets and sets a reference to the worksheet. |
setLinkedSource(string) | Gets and sets a reference to the worksheet. |
constructor(ChartTextFrame)
Constructs from a parent object convertible to this.
constructor(obj: ChartTextFrame);
Parameters:
Parameter | Type | Description |
---|---|---|
obj | ChartTextFrame | The parent object. |
border
Readonly. Gets the
border : Line;
area
Readonly. Gets the
area : Area;
isAutoText
Indicates the text is auto generated.
isAutoText : boolean;
directionType
Gets and sets the direction of text.
directionType : ChartTextDirectionType;
text
Gets or sets the text of data label.
text : string;
isTextWrapped
Gets or sets a value indicating whether the text is wrapped.
isTextWrapped : boolean;
backgroundMode
Gets and sets the display mode of the background
backgroundMode : BackgroundMode;
showValue
Represents a specified chart’s data label values display behavior. True displays the values. False to hide.
showValue : boolean;
showCellRange
Indicates whether showing cell range as the data labels.
showCellRange : boolean;
showPercentage
Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
showPercentage : boolean;
showBubbleSize
Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
showBubbleSize : boolean;
showCategoryName
Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.
showCategoryName : boolean;
showSeriesName
Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
showSeriesName : boolean;
showLegendKey
Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible.
showLegendKey : boolean;
numberFormat
Represents the format string for the DataLabels object.
numberFormat : string;
number
Gets and sets the built-in number format.
number : number;
numberFormatLinked
True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
numberFormatLinked : boolean;
font
Readonly. Gets the font of the DataLabels;
font : Font;
separatorType
Gets or sets the separator type used for the data labels on a chart.
separatorType : DataLabelsSeparatorType;
Remarks
To set custom separator, please set the property DataLabels.SeparatorType as DataLabelsSeparatorType.Custom and then specify the expected value for DataLabels.SeparatorValue.
separatorValue
Gets or sets the separator value used for the data labels on a chart.
separatorValue : string;
position
Represents the position of the data label.
position : LabelPositionType;
isNeverOverlap
Indicates whether the datalabels display never overlap. (For Pie chart)
isNeverOverlap : boolean;
shapeType
Gets or sets shape type of data label.
shapeType : DataLabelShapeType;
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.
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;
isDeleted
Indicates whether this data labels is deleted.
isDeleted : boolean;
textHorizontalAlignment
Gets and sets the text horizontal alignment.
textHorizontalAlignment : TextAlignmentType;
textVerticalAlignment
Gets or sets the text vertical alignment of text.
textVerticalAlignment : TextAlignmentType;
rotationAngle
Represents text rotation angle.
rotationAngle : number;
Remarks
br>0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.</br
isAutomaticRotation
Readonly. Indicates whether the text of the chart is automatically rotated.
isAutomaticRotation : boolean;
readingOrder
Represents text reading order.
readingOrder : TextDirectionType;
isResizeShapeToFitText
Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
isResizeShapeToFitText : boolean;
getBorder()
@deprecated. Please use the ‘border’ property instead. Gets the
getBorder() : Line;
Returns
getArea()
@deprecated. Please use the ‘area’ property instead. Gets the
getArea() : Area;
Returns
isAutoText()
@deprecated. Please use the ‘isAutoText’ property instead. Indicates the text is auto generated.
isAutoText() : boolean;
setIsAutoText(boolean)
@deprecated. Please use the ‘isAutoText’ property instead. Indicates the text is auto generated.
setIsAutoText(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getDirectionType()
@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.
getDirectionType() : ChartTextDirectionType;
Returns
setDirectionType(ChartTextDirectionType)
@deprecated. Please use the ‘directionType’ property instead. Gets and sets the direction of text.
setDirectionType(value: ChartTextDirectionType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ChartTextDirectionType | The value to set. |
getText()
@deprecated. Please use the ’text’ property instead. Gets or sets the text of data label.
getText() : string;
setText(string)
@deprecated. Please use the ’text’ property instead. Gets or sets the text of data label.
setText(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
isTextWrapped()
@deprecated. Please use the ‘isTextWrapped’ property instead. Gets or sets a value indicating whether the text is wrapped.
isTextWrapped() : boolean;
setIsTextWrapped(boolean)
@deprecated. Please use the ‘isTextWrapped’ property instead. Gets or sets a value indicating whether the text is wrapped.
setIsTextWrapped(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
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. |
getShowValue()
@deprecated. Please use the ‘showValue’ property instead. Represents a specified chart’s data label values display behavior. True displays the values. False to hide.
getShowValue() : boolean;
setShowValue(boolean)
@deprecated. Please use the ‘showValue’ property instead. Represents a specified chart’s data label values display behavior. True displays the values. False to hide.
setShowValue(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowCellRange()
@deprecated. Please use the ‘showCellRange’ property instead. Indicates whether showing cell range as the data labels.
getShowCellRange() : boolean;
setShowCellRange(boolean)
@deprecated. Please use the ‘showCellRange’ property instead. Indicates whether showing cell range as the data labels.
setShowCellRange(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowPercentage()
@deprecated. Please use the ‘showPercentage’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
getShowPercentage() : boolean;
setShowPercentage(boolean)
@deprecated. Please use the ‘showPercentage’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
setShowPercentage(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowBubbleSize()
@deprecated. Please use the ‘showBubbleSize’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
getShowBubbleSize() : boolean;
setShowBubbleSize(boolean)
@deprecated. Please use the ‘showBubbleSize’ property instead. Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
setShowBubbleSize(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowCategoryName()
@deprecated. Please use the ‘showCategoryName’ property instead. Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.
getShowCategoryName() : boolean;
setShowCategoryName(boolean)
@deprecated. Please use the ‘showCategoryName’ property instead. Represents a specified chart’s data label category name display behavior.True to display the category name for the data labels on a chart. False to hide.
setShowCategoryName(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowSeriesName()
@deprecated. Please use the ‘showSeriesName’ property instead. Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
getShowSeriesName() : boolean;
setShowSeriesName(boolean)
@deprecated. Please use the ‘showSeriesName’ property instead. Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
setShowSeriesName(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShowLegendKey()
@deprecated. Please use the ‘showLegendKey’ property instead. Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible.
getShowLegendKey() : boolean;
setShowLegendKey(boolean)
@deprecated. Please use the ‘showLegendKey’ property instead. Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible.
setShowLegendKey(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
get_NumberFormat()
@deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the DataLabels object.
get_NumberFormat() : string;
setNumberFormat(string)
@deprecated. Please use the ’numberFormat’ property instead. Represents the format string for the DataLabels object.
setNumberFormat(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getNumber()
@deprecated. Please use the ’number’ property instead. Gets and sets the built-in number format.
getNumber() : number;
setNumber(number)
@deprecated. Please use the ’number’ property instead. Gets and sets the built-in number format.
setNumber(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getNumberFormatLinked()
@deprecated. Please use the ’numberFormatLinked’ property instead. True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
getNumberFormatLinked() : boolean;
setNumberFormatLinked(boolean)
@deprecated. Please use the ’numberFormatLinked’ property instead. True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
setNumberFormatLinked(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getFont()
@deprecated. Please use the ‘font’ property instead. Gets the font of the DataLabels;
getFont() : Font;
Returns
getSeparatorType()
@deprecated. Please use the ‘separatorType’ property instead. Gets or sets the separator type used for the data labels on a chart.
getSeparatorType() : DataLabelsSeparatorType;
Returns
Remarks
To set custom separator, please set the property DataLabels.SeparatorType as DataLabelsSeparatorType.Custom and then specify the expected value for DataLabels.SeparatorValue.
setSeparatorType(DataLabelsSeparatorType)
@deprecated. Please use the ‘separatorType’ property instead. Gets or sets the separator type used for the data labels on a chart.
setSeparatorType(value: DataLabelsSeparatorType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | DataLabelsSeparatorType | The value to set. |
Remarks
To set custom separator, please set the property DataLabels.SeparatorType as DataLabelsSeparatorType.Custom and then specify the expected value for DataLabels.SeparatorValue.
getSeparatorValue()
@deprecated. Please use the ‘separatorValue’ property instead. Gets or sets the separator value used for the data labels on a chart.
getSeparatorValue() : string;
setSeparatorValue(string)
@deprecated. Please use the ‘separatorValue’ property instead. Gets or sets the separator value used for the data labels on a chart.
setSeparatorValue(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getPosition()
@deprecated. Please use the ‘position’ property instead. Represents the position of the data label.
getPosition() : LabelPositionType;
Returns
setPosition(LabelPositionType)
@deprecated. Please use the ‘position’ property instead. Represents the position of the data label.
setPosition(value: LabelPositionType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | LabelPositionType | The value to set. |
isNeverOverlap()
@deprecated. Please use the ‘isNeverOverlap’ property instead. Indicates whether the datalabels display never overlap. (For Pie chart)
isNeverOverlap() : boolean;
setIsNeverOverlap(boolean)
@deprecated. Please use the ‘isNeverOverlap’ property instead. Indicates whether the datalabels display never overlap. (For Pie chart)
setIsNeverOverlap(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getShapeType()
@deprecated. Please use the ‘shapeType’ property instead. Gets or sets shape type of data label.
getShapeType() : DataLabelShapeType;
Returns
setShapeType(DataLabelShapeType)
@deprecated. Please use the ‘shapeType’ property instead. Gets or sets shape type of data label.
setShapeType(value: DataLabelShapeType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | DataLabelShapeType | The value to set. |
applyFont()
Apply the font of the datalabels to all child nodes.
applyFont() : void;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
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.
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;
isDeleted()
@deprecated. Please use the ‘isDeleted’ property instead. Indicates whether this data labels is deleted.
isDeleted() : boolean;
setIsDeleted(boolean)
@deprecated. Please use the ‘isDeleted’ property instead. Indicates whether this data labels is deleted.
setIsDeleted(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getTextHorizontalAlignment()
@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment.
getTextHorizontalAlignment() : TextAlignmentType;
Returns
setTextHorizontalAlignment(TextAlignmentType)
@deprecated. Please use the ’textHorizontalAlignment’ property instead. Gets and sets the text horizontal alignment.
setTextHorizontalAlignment(value: TextAlignmentType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | TextAlignmentType | The value to set. |
getTextVerticalAlignment()
@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets or sets the text vertical alignment of text.
getTextVerticalAlignment() : TextAlignmentType;
Returns
setTextVerticalAlignment(TextAlignmentType)
@deprecated. Please use the ’textVerticalAlignment’ property instead. Gets or sets the text vertical alignment of text.
setTextVerticalAlignment(value: TextAlignmentType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | TextAlignmentType | The value to set. |
getRotationAngle()
@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle.
getRotationAngle() : number;
Remarks
br>0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.</br
setRotationAngle(number)
@deprecated. Please use the ‘rotationAngle’ property instead. Represents text rotation angle.
setRotationAngle(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
Remarks
br>0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.</br
isAutomaticRotation()
@deprecated. Please use the ‘isAutomaticRotation’ property instead. Indicates whether the text of the chart is automatically rotated.
isAutomaticRotation() : boolean;
getReadingOrder()
@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.
getReadingOrder() : TextDirectionType;
Returns
setReadingOrder(TextDirectionType)
@deprecated. Please use the ‘readingOrder’ property instead. Represents text reading order.
setReadingOrder(value: TextDirectionType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | TextDirectionType | The value to set. |
isResizeShapeToFitText()
@deprecated. Please use the ‘isResizeShapeToFitText’ property instead. Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
isResizeShapeToFitText() : boolean;
setIsResizeShapeToFitText(boolean)
@deprecated. Please use the ‘isResizeShapeToFitText’ property instead. Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
setIsResizeShapeToFitText(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
characters(number, number)
Returns a Characters object that represents a range of characters within the text.
characters(startIndex: number, length: number) : FontSetting;
Parameters:
Parameter | Type | Description |
---|---|---|
startIndex | number | The index of the start of the character. |
length | number | The number of characters. |
Returns
Characters object.
getTextOptions()
Gets and sets the options of the text.
getTextOptions() : TextOptions;
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;
getLinkedSource()
Gets and sets a reference to the worksheet.
getLinkedSource() : string;
setLinkedSource(string)
Gets and sets a reference to the worksheet.
setLinkedSource(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |