ConditionalFormattingValue

Home > @gooddata/sdk-ui-pivot > ConditionalFormattingValue

ConditionalFormattingValue type

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The operand a condition compares against. Discriminated so range / no-operand / date / (future column-reference) shapes stay valid by construction.

Date values target date attributes and express a period; a single date is a period whose bounds coincide. "Is on" (EQUAL_TO) means the cell's period lies within the value period; "Is after" (GREATER_THAN) means after the period ends; "Is before" (LESS_THAN) before it starts.

Signature:

export type ConditionalFormattingValue = {
    kind: "none";
} | {
    kind: "literal";
    value: string | number;
} | {
    kind: "literalRange";
    from: number;
    to: number;
} | {
    kind: "absoluteDate";
    from: string;
    to: string;
} | {
    kind: "relativeDate";
    granularity: DateFilterGranularity;
    from: number;
    to: number;
};

References: DateFilterGranularity

← ConditionalFormattingTextOperatorDefaultColumnWidth →