AppearanceSettings Class
Contains style settings used to apply conditional formatting by changing appearance settings.
#Declaration
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.
#Inheritance
#constructor
Initializes a new instance of the AppearanceSettings
class.
#Declaration
constructor(
modelJson?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
model |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
An object used for dashboard deserialization. Do not pass this parameter directly. |
#Properties
#appearanceType Property
Specifies predefined appearance settings.
#Declaration
appearanceType: ko.Observable<DevExpress.Dashboard.Model.FormatConditionAppearanceType>
#Property Value
Type | Description |
---|---|
Observable<Format |
A Format |
#backColor Property
Specifies the background color.
#Declaration
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
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
fontStyle: ko.Observable<DevExpress.Dashboard.Model.FontStyle>
#Property Value
Type | Description |
---|---|
Observable<Font |
A Font |
#foreColor Property
Specifies the foreground color.
#Declaration
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
clone(): DevExpress.Dashboard.Model.StyleSettingsBase
#Returns
Type | Description |
---|---|
Style |
A Style |
#equals(style) Method
Determines whether the style is equal to the current AppearanceSettings
instance’s style.
#Declaration
equals(
style: DevExpress.Dashboard.Model.StyleSettingsBase
): boolean
#Parameters
Name | Type | Description |
---|---|---|
style | Style |
The Style |
#Returns
Type | Description |
---|---|
boolean | true, if the style is equal to the current Appearance |
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |
#init Method
#Declaration
init(): void
#setSpecificType(type) Method
#Declaration
setSpecificType(
type: DevExpress.Dashboard.Model.FormatConditionAppearanceType
): void
#Parameters
Name | Type |
---|---|
type | Format |