setDateFilterConfigTitle()

Home > @gooddata/sdk-ui-dashboard > setDateFilterConfigTitle

setDateFilterConfigTitle() function

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

Creates the ISetDateFilterConfigTitle command.

Signature:

export declare function setDateFilterConfigTitle(dataSet?: ObjRef, title?: string, correlationId?: string): ISetDateFilterConfigTitle;

Parameters

Parameter	Type	Description
dataSet	ObjRef	(Optional) date data set ref of the filter the display form is changed for
title	string	(Optional) newly added title
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

ISetDateFilterConfigTitle

change filter title command

Remarks

Dispatching the commands will result into setting provided title as a selected title for the date filter.