LegendEntry

LegendEntry class

Represents a legend entry in a chart legend.

class LegendEntry;

Properties

PropertyTypeDescription
isDeletedbooleanGets and sets whether the legend entry is deleted.
fontFontReadonly. Gets a Font object of the specified ChartFrame object.
isTextNoFillbooleanGets or sets no fill of the text.
autoScaleFontbooleanTrue if the text in the object changes font size when the object size changes. The default value is True.
backgroundModeBackgroundModeGets and sets the display mode of the background

Methods

MethodDescription
isDeleted()@deprecated. Please use the ‘isDeleted’ property instead. Gets and sets whether the legend entry is deleted.
setIsDeleted(boolean)@deprecated. Please use the ‘isDeleted’ property instead. Gets and sets whether the legend entry is deleted.
getFont()@deprecated. Please use the ‘font’ property instead. Gets a Font object of the specified ChartFrame object.
isTextNoFill()@deprecated. Please use the ‘isTextNoFill’ property instead. Gets or sets no fill of the text.
setIsTextNoFill(boolean)@deprecated. Please use the ‘isTextNoFill’ property instead. Gets or sets no fill of the text.
getAutoScaleFont()@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.
setAutoScaleFont(boolean)@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.
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
isNull()Checks whether the implementation object is null.

isDeleted

Gets and sets whether the legend entry is deleted.

isDeleted : boolean;

font

Readonly. Gets a Font object of the specified ChartFrame object.

font : Font;

isTextNoFill

Gets or sets no fill of the text.

isTextNoFill : boolean;

autoScaleFont

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

autoScaleFont : boolean;

backgroundMode

Gets and sets the display mode of the background

backgroundMode : BackgroundMode;

isDeleted()

@deprecated. Please use the ‘isDeleted’ property instead. Gets and sets whether the legend entry is deleted.

isDeleted() : boolean;

setIsDeleted(boolean)

@deprecated. Please use the ‘isDeleted’ property instead. Gets and sets whether the legend entry is deleted.

setIsDeleted(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFont()

@deprecated. Please use the ‘font’ property instead. Gets a Font object of the specified ChartFrame object.

getFont() : Font;

Returns

Font

isTextNoFill()

@deprecated. Please use the ‘isTextNoFill’ property instead. Gets or sets no fill of the text.

isTextNoFill() : boolean;

setIsTextNoFill(boolean)

@deprecated. Please use the ‘isTextNoFill’ property instead. Gets or sets no fill of the text.

setIsTextNoFill(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAutoScaleFont()

@deprecated. Please use the ‘autoScaleFont’ property instead. True if the text in the object changes font size when the object size changes. The default value is True.

getAutoScaleFont() : boolean;

setAutoScaleFont(boolean)

@deprecated. Please use the ‘autoScaleFont’ property instead. 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:

ParameterTypeDescription
valuebooleanThe value to set.

getBackgroundMode()

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

getBackgroundMode() : BackgroundMode;

Returns

BackgroundMode

setBackgroundMode(BackgroundMode)

@deprecated. Please use the ‘backgroundMode’ property instead. Gets and sets the display mode of the background

setBackgroundMode(value: BackgroundMode) : void;

Parameters:

ParameterTypeDescription
valueBackgroundModeThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;