FieldObjectReturned

This object is returned by the filteropen event and the getAllHierarchies(), getColumns(), getReportFilters(), getRows() methods. It can describe:

A field for which the filter pop-up window was opened.
Fields in rows, columns, or report filters.
All fields from the dataset.

Properties

{
  uniqueName: string,
  caption: string,
  dimensionUniqueName: string
  dimensionCaption: string
  folder: string,
  levels: FieldObjectReturned[],
  sort: string,
  type: string
}

Property/Type	Description
uniqueName String	The field's unique name.
caption String	The field's caption.
dimensionUniqueName String	The dimension name.
dimensionCaption String	The dimension caption.
folder String	The field’s folder, if defined. Only for `"json"`, `"csv"`, and `"api"` data source types.
levels FieldObjectReturned[]	If the field is a multilevel hierarchy, this property lists the field members that compose the hierarchy. Each member is a FieldObjectReturned with only the uniqueName and caption properties.
sort String	The sorting type for members: `"asc"`, `"desc"` or `"unsorted"`.
type String	The field's data type. Only for `"json"`, `"csv"`, `"api"`, and `"elasticsearch"` data sources: For `"json"` and `"csv"`, the `type` can be the following: `"string"`, `"number"`, `"date"`, `"date string"`, `"year/month/day"`, `"year/quarter/month/day"`, `"datetime"`, `"time"`. For `"api"`, the `type` can be the following: `"string"`, `"number"`, `"date string"`, `"datetime"`, `"time"`. For `"elasticsearch"`, the `type`’s possible values are described here: Field data types.

Examples

The example below shows an array of FieldObjectReturned objects returned by the getAllHierarchies() method:

flexmonster.getAllHierarchies();

/* method returns an array of FieldObjectReturned objects 
[
  {caption: "Business Type", uniqueName: "Business Type", type: "string"},
  {caption: "Category", uniqueName: "Category", type: "string"},
  {caption: "Country", uniqueName: "Country", type: "string"}
]
*/

Live example

FieldObjectReturned

Properties

Examples

See also