IComparison

Home > @gooddata/sdk-ui-charts > IComparison

IComparison interface

Signature:

export interface IComparison

Properties

PropertyModifiersTypeDescription
calculationType?CalculationType

(Optional) This property defines how the comparison value will be calculated.

See CalculationType to understand the calculation method

colorConfig?IColorConfig

(Optional) This property controls application of conditional colors

See IColorConfig to understand config details

enabledbooleanenable/disable comparison
format?string(Optional) This property Defines number format of the comparison value
isArrowEnabled?boolean

(Optional) This property controls Indicator/Arrow visibility of arrow trend indicator

ConditionDirection
Primary > SecondaryUp
Primary < SecondaryDown
Primary = SecondaryNo direction, arrow is hidden

isSignEnabled?boolean

(Optional) This property controls plus and minus sign before the number

ConditionSign
Primary > Secondary+
Primary < Secondary-
Primary = SecondarySign is hidden

labelConfig?ILabelConfig

(Optional) This property controls string under the comparison value

See ILabelConfig to understand config details

position?ComparisonPositionType

(Optional) This property defines how the comparison value will be placed.

See ComparisonPositionType to know the supported positions

subFormat?string(Optional) This property defines the number format of the comparison sub-value when using CalculationType.CHANGE_DIFFERENCE.
← ICommonChartPropsIContinuousLineConfig →