Skip to main content

AppearanceSettings Class

Contains style settings used to apply conditional formatting by changing appearance settings.

#Declaration

TypeScript
export class AppearanceSettings extends StyleSettingsBase

#Remarks

Use the backColor and foreColor properties to set the element’s background or foreground colors, respectively.

Use the fontFamily and fontStyle properties to specify font settings. Note that the appearanceType property should be set to Custom to take custom appearance settings into account.

#Inherited Members

#Inheritance

#constructor

Initializes a new instance of the AppearanceSettings class.

#Declaration

TypeScript
constructor(
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
modelJson any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#appearanceType Property

Specifies predefined appearance settings.

#Declaration

TypeScript
appearanceType: ko.Observable<DevExpress.Dashboard.Model.FormatConditionAppearanceType>

#Property Value

Type Description
Observable<FormatConditionAppearanceType>

A FormatConditionAppearanceType object that specifies predefined appearance settings.

#backColor Property

Specifies the background color.

#Declaration

TypeScript
backColor: ko.Observable<DevExpress.Dashboard.Model.Color>

#Property Value

Type Description
Observable<Color>

A Color value that specifies the background color.

#fontFamily Property

Specifies the font family.

#Declaration

TypeScript
fontFamily: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string that specifies the font family.

#fontStyle Property

Specifies the style applied to text.

#Declaration

TypeScript
fontStyle: ko.Observable<DevExpress.Dashboard.Model.FontStyle>

#Property Value

Type Description
Observable<FontStyle>

A FontStyle value that specifies the style applied to text.

#foreColor Property

Specifies the foreground color.

#Declaration

TypeScript
foreColor: ko.Observable<DevExpress.Dashboard.Model.Color>

#Property Value

Type Description
Observable<Color>

A Color value that specifies the foreground color.

#Methods

#clone Method

Creates a copy of the current AppearanceSettings object.

#Declaration

TypeScript
clone(): DevExpress.Dashboard.Model.StyleSettingsBase

#Returns

Type Description
StyleSettingsBase

A StyleSettingsBase object that provides style settings used to apply conditional formatting.

#equals(style) Method

Determines whether the style is equal to the current AppearanceSettings instance’s style.

#Declaration

TypeScript
equals(
    style: DevExpress.Dashboard.Model.StyleSettingsBase
): boolean

#Parameters

Name Type Description
style StyleSettingsBase

The StyleSettingsBase to compare with the style.

#Returns

Type Description
boolean

true, if the style is equal to the current AppearanceSettings instance; otherwise, false.

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

#init Method

#Declaration

TypeScript
init(): void

#setSpecificType(type) Method

#Declaration

TypeScript
setSpecificType(
    type: DevExpress.Dashboard.Model.FormatConditionAppearanceType
): void

#Parameters

Name Type
type FormatConditionAppearanceType