StyleSettingsBase Class

Serves as the base for classes providing style settings used to apply conditional formatting.

Declaration

export abstract class StyleSettingsBase extends SerializableModel

Inheritance

StyleSettingsBase

AppearanceSettings

ColorStyleSettings

IconSettings

RangeIndexSettings

constructor

Initializes a new instance of the StyleSettingsBase class.

Declaration

constructor(
    modelJson?: any,
    serializer?: 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.

Methods

clone Method

Creates a copy of the current StyleSettingsBase object.

Declaration

abstract clone(): 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 StyleSettingsBase instance.

Declaration

abstract equals(
    style: 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 StyleSettingsBase instance; otherwise, false.

getInfo Method

For internal use.

Declaration

getInfo(): ISerializationInfoArray

Returns

Type	Description
ISerializationInfoArray	An array of objects that provide serialization info.

init Method

Declaration

init(): void

setSpecificType(type) Method

Declaration

setSpecificType(
    type: string
): void

Parameters

Name	Type
type	string