Forest Admin - API reference
    Preparing search index...
    Index

    Constructors

    Methods

    • Parameters

      • leaf: ConditionTreeLeaf
      • operators: Set<
            | "Equal"
            | "NotEqual"
            | "LessThan"
            | "GreaterThan"
            | "LessThanOrEqual"
            | "GreaterThanOrEqual"
            | "Match"
            | "NotContains"
            | "NotIContains"
            | "LongerThan"
            | "ShorterThan"
            | "IncludesAll"
            | "IncludesNone"
            | "Today"
            | "Yesterday"
            | "PreviousMonth"
            | "PreviousQuarter"
            | "PreviousWeek"
            | "PreviousYear"
            | "PreviousMonthToDate"
            | "PreviousQuarterToDate"
            | "PreviousWeekToDate"
            | "PreviousXDaysToDate"
            | "PreviousXDays"
            | "PreviousYearToDate"
            | "Present"
            | "Blank"
            | "Missing"
            | "In"
            | "NotIn"
            | "StartsWith"
            | "EndsWith"
            | "Contains"
            | "IStartsWith"
            | "IEndsWith"
            | "IContains"
            | "Like"
            | "ILike"
            | "Before"
            | "After"
            | "AfterXHoursAgo"
            | "BeforeXHoursAgo"
            | "Future"
            | "Past",
        >
      • columnType: ColumnType
      • timezone: string

      Returns ConditionTree

    • Parameters

      • operator:
            | "Equal"
            | "NotEqual"
            | "LessThan"
            | "GreaterThan"
            | "LessThanOrEqual"
            | "GreaterThanOrEqual"
            | "Match"
            | "NotContains"
            | "NotIContains"
            | "LongerThan"
            | "ShorterThan"
            | "IncludesAll"
            | "IncludesNone"
            | "Today"
            | "Yesterday"
            | "PreviousMonth"
            | "PreviousQuarter"
            | "PreviousWeek"
            | "PreviousYear"
            | "PreviousMonthToDate"
            | "PreviousQuarterToDate"
            | "PreviousWeekToDate"
            | "PreviousXDaysToDate"
            | "PreviousXDays"
            | "PreviousYearToDate"
            | "Present"
            | "Blank"
            | "Missing"
            | "In"
            | "NotIn"
            | "StartsWith"
            | "EndsWith"
            | "Contains"
            | "IStartsWith"
            | "IEndsWith"
            | "IContains"
            | "Like"
            | "ILike"
            | "Before"
            | "After"
            | "AfterXHoursAgo"
            | "BeforeXHoursAgo"
            | "Future"
            | "Past"
      • operators: Set<
            | "Equal"
            | "NotEqual"
            | "LessThan"
            | "GreaterThan"
            | "LessThanOrEqual"
            | "GreaterThanOrEqual"
            | "Match"
            | "NotContains"
            | "NotIContains"
            | "LongerThan"
            | "ShorterThan"
            | "IncludesAll"
            | "IncludesNone"
            | "Today"
            | "Yesterday"
            | "PreviousMonth"
            | "PreviousQuarter"
            | "PreviousWeek"
            | "PreviousYear"
            | "PreviousMonthToDate"
            | "PreviousQuarterToDate"
            | "PreviousWeekToDate"
            | "PreviousXDaysToDate"
            | "PreviousXDays"
            | "PreviousYearToDate"
            | "Present"
            | "Blank"
            | "Missing"
            | "In"
            | "NotIn"
            | "StartsWith"
            | "EndsWith"
            | "Contains"
            | "IStartsWith"
            | "IEndsWith"
            | "IContains"
            | "Like"
            | "ILike"
            | "Before"
            | "After"
            | "AfterXHoursAgo"
            | "BeforeXHoursAgo"
            | "Future"
            | "Past",
        >
      • columnType: ColumnType

      Returns boolean