Axinom Mosaic Libraries
    Preparing search index...

    Class DateTimeFilter

    A model for a Filter component with filter type 'DateTime'.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    clearButton label root value xpath

    Accessors

    filterTypeValidator

    Methods

    activate getChildOfType getGlobalLocator getLocator setValue verifyFilterType

    Constructors

    • A model for a filter component.

      Parameters

      • parent: ComponentModel | Page | FrameLocator

        The parent playwright page, frame or component model.

      • Optionalxpath: string

        A relative xpath selector to this element from the parent.

      • Optionalnth: number

        Position among matching elements. Position is 1 indexed. Negative numbers count from the end.

      Returns DateTimeFilter

    Properties

    clearButton: Locator

    A locator to the button which clears the filter.

    label: Locator

    A locator to the filter label.

    root: Page | FrameLocator

    The root playwright entity from which to resolve this component model's xpath.

    value: Locator

    A locator to the element with the selected value.

    xpath: string

    An absolute xpath to the DOM element that this component model represents.

    Accessors

    • get filterTypeValidator(): string

      A selector which will match the filter if the element type is correct.

      Returns string

    Methods

    • This method expands the filter for input.

      Returns Promise<void>

    • This method gets a child component model with a provided type. This is useful for modelling a page where the UI is composed in a custom manner.

      Type Parameters

      Parameters

      • model: ComponentModelType<TModel>

        A ComponentModel type. e.g. ToggleButton / Modal

      • Optionalxpath: string

        An optional xpath relative to this component. If not provided, the model's default xpath will be used.

      • Optionalnth: number

        Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

      Returns TModel

    • A helper method to create global locators - This helps with locating globally across the entire DOM, rather than being scoped to the form

      Parameters

      • selector: string

      Returns Locator

    • This method gets a locator to the DOM element represented by this component model.

      Returns Locator

    • This method gets a locator to a DOM element relative to the element represented by this component model.

      Parameters

      • xpath: string

        An xpath relative to this component.

      • Optionalnth: number

        Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

      Returns Locator

    • This method performs actions:

      • Verify the filter type
      • Activate the filter
      • Set the filter value through text entry
      • Press enter

      Parameters

      • value: string | Date

      Returns Promise<void>

    • This method verifies that the filter is visible, and that the actual element matches the model being used.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods