This migration guide describes significant new features and breaking changes in version 2.7. To see the full list of new features and fixes in version 2.7, visit the Release notes page.
getFilterProperties
was removed in version 2.7. Use getFilter() instead.setTopX
was removed in version 2.7. Use setFilter() instead.setBottomX
was removed in version 2.7. Use setFilter() instead.getFilter(hierarchyName: String)
now returns a FilterObject (instead of an array with members).setFilter(hierarchyName: String, filter: FilterObject)
now takes a FilterObject as a second argument (instead of an array with members).columns.filter
, rows.filter
, and reportFilters.filter
from the SliceObject were changed, find the new structure here: FilterObject. The following filtering properties were removed (they remain available in terms of backward compatibility):
filter.negation
was removed in version 2.7. Use exclude
from the FilterObject instead.filter.quantity
was removed in version 2.7. Use query
from the FilterObject instead.filter.type
was removed in version 2.7. Use query
from the FilterObject instead. filter
– Object. Filtering options:
timezoneOffset
– Number. The difference (in minutes) between UTC and the user’s local time zone. Used to adjust the dates in the filter. Default value: user’s local time.weekOffset
– Number. The number of days to be added to the start of the week (Sunday). Used to adjust the first day of the week in the filter’s calendar. Default value: 1
(Monday is the first day of the week).dateFormat
– String. The date pattern to format dates in the filter’s date inputs. Has two possible values: "dd/MM/yyyy"
and "MM/dd/yyyy"
. Default value: "dd/MM/yyyy"
. dataSource
from the ReportObject was extended with the following properties:
host
optional – String | Object. The host for the connection (only for the "elasticsearch"
data source type). Can be set either as a URL string ("host": "https://olap.flexmonster.com:9200"
) or as a Host Object.index
optional – String. The name of the Elasticsearch index to connect to (only for the "elasticsearch"
data source type).mapping
optional – Object. An additional setting to configure index mapping (only for "elasticsearch"
data source type). Use the name of the field as a key of the object with the following parameters:
caption
optional – String. Overrides the default name of the field.visible
optional – Boolean. When set to false
, it hides the field from the Field List.interval
optional – String. Used for the date histogram. Check out the supported time units.time_zone
optional – String. Used for the date histogram. You can specify time zones either as an ISO 8601 UTC offset (e.g. +01:00
or -08:00
) or as a time zone ID as specified in the IANA time zone database, such as America/Los_Angeles
. Check out this example.format
optional – String. Used for the date histogram. Check out the date format/pattern. Flexmonster now supports connecting to an Elasticsearch data source out of the box. Find more details in our blog post.
New localization labels were added in version 2.7. Get the updated localization files from our GitHub repository.
In 2.7 we added support of ./
(that means the current directory) for dataSource.filename
and localization
URLs. All details are covered below:
/
or ./
– the path will be resolved using the componentFolder
+ filename
./
– the path will be resolved using the root directory (website root)../
– the path will be resolved using the current directory (current HTML page path).../
– the path will be resolved using the parent folder of the componentFolder
.If migrating from a previous major version, follow these tutorials: