Skip to content
RevoGrid [Pro]

Conditional Formatting

ConditionalFormattingDialogPlugin

Section titled “ConditionalFormattingDialogPlugin”

Dependencies

Section titled “Dependencies”
  • Auto-installed DialogPlugin: Uses the shared Pro dialog runtime for conditional-formatting editors.
class ConditionalFormattingDialogPlugin {
  open(options: ConditionalFormattingDialogOpenOptions): void;


  close(): void;
}

createConditionalFormattingEditor

Section titled “createConditionalFormattingEditor”
export function createConditionalFormattingEditor({
  document,
  localeText,
  operators,
  initialValue,
}: ConditionalFormattingEditorOptions): ConditionalFormattingEditor;

ConditionalFormattingEditor

Section titled “ConditionalFormattingEditor”
interface ConditionalFormattingEditor {
  readonly element: HTMLElement;
  readonly secondValueField: HTMLLabelElement;
  readonly preview: HTMLElement;
  getDraft(): ConditionalFormattingDialogDraft;
  isValid(): boolean
}

ConditionalFormattingOperatorOption

Section titled “ConditionalFormattingOperatorOption”
interface ConditionalFormattingOperatorOption {
  readonly value: string;
  readonly label: string;
  readonly usesSecondValue?: boolean
}

ConditionalFormattingDialogDraft

Section titled “ConditionalFormattingDialogDraft”
interface ConditionalFormattingDialogDraft {
  readonly operator: string;
  readonly value: string;
  readonly secondValue: string;
  readonly backgroundColor: string;
  readonly textColor: string
}

ConditionalFormattingDialogLocaleText

Section titled “ConditionalFormattingDialogLocaleText”
interface ConditionalFormattingDialogLocaleText {
  readonly description: string;
  readonly rule: string;
  readonly condition: string;
  readonly value: string;
  readonly secondValue: string;
  readonly valuePlaceholder: string;
  readonly secondValuePlaceholder: string;
  readonly appearance: string;
  readonly background: string;
  readonly text: string;
  readonly preview: string;
  readonly sampleValue: string;
  readonly clearRules: string;
  readonly cancel: string;
  readonly apply: string
}

ConditionalFormattingDialogOpenOptions

Section titled “ConditionalFormattingDialogOpenOptions”
interface ConditionalFormattingDialogOpenOptions {
  readonly title: string;
  readonly closeLabel: string;
  readonly localeText: ConditionalFormattingDialogLocaleText;
  readonly operators: readonly ConditionalFormattingOperatorOption[];
  readonly initialValue?: Partial<ConditionalFormattingDialogDraft>;
  readonly onApply: (draft: ConditionalFormattingDialogDraft) => void;
  readonly onClear: () => void
}