Back to Devexpress

DateFilterWidget Class

dashboard-js-devexpress-dot-dashboard-9881dc5e.md

latest2.9 KB
Original Source

DateFilterWidget Class

A Date Filter’s underlying widget that provides the Date Filter’s functionality.

Declaration

ts
export class DateFilterWidget

constructor(element, viewerOptions, boundaryElementContainer)

Initializes a new instance of the DateFilterWidget class with specified settings.

Declaration

ts
constructor(
    element: HTMLElement,
    viewerOptions: any,
    boundaryElementContainer: HTMLElement
)

Parameters

NameType
elementHTMLElement
viewerOptionsany
boundaryElementContainerHTMLElement

Properties

calendarFrom Property

Gets a calendar widget that you can use to set a start date.

Declaration

ts
get calendarFrom(): DevExpress.ui.dxCalendar

Property Value

TypeDescription
dxCalendar

An underlying widget (dxCalendar that allows you set a start date.

|

calendarTo Property

Gets a calendar widget that you can use to set an end date.

Declaration

ts
get calendarTo(): DevExpress.ui.dxCalendar

Property Value

TypeDescription
dxCalendar

An underlying widget (dxCalendar that allows you set an end date.

|

datePickerButton Property

Gets a ButtonGroup widget that contains a set of toggle buttons you can use to switch between date ranges.

Declaration

ts
datePickerButton: DevExpress.ui.dxButtonGroup

Property Value

TypeDescription
dxButtonGroup

An underlying widget (dxButtonGroup) used as a mode switcher in the DateFilter dashboard item.

|

quickButtons Property

Provides access to the quick filters.

Declaration

ts
quickButtons: Array<DevExpress.ui.dxButtonGroup>

Property Value

TypeDescription
dxButtonGroup[]

An array of underlying widgets (dxButtonGroup) used as quick filters in the DateFilter dashboard item.

|

Methods

dispose Method

Disposes of all resources associated with this DateFilterWidget.

Declaration

ts
dispose(): void

element Method

Specifies a container where the item content is rendered.

Declaration

ts
element(): DevExpress.Dashboard.DxElement

Returns

TypeDescription
DxElement

A container where the item content is rendered. It is an HTML Element or a jQuery Element when you use jQuery.

|