ISettings
Home > @gooddata/sdk-model > ISettings
ISettings interface
Settings are obtained from backend and are effectively a collection of feature flags or settings with concrete string or numeric value.
Signature:
export interface ISettings
Remarks
Settings are stored and configured on the server and typically allow for a more fine-grained tuning of otherwise unified behavior.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| ADCatalogGroupsExpanded? | boolean | (Optional) Indicates whether the catalog groups in analytical designer are expanded by default. | |
| ADMeasureValueFilterNullAsZeroOption? | string | (Optional) Indicates whether "Treat null as zero" option should be displayed in measure value filter configuration and its default state" | |
| alertDefault? | IAlertDefault | (Optional) Represents alert default configuration | |
| disableKpiDashboardHeadlineUnderline? | boolean | (Optional) Headline component will not be underlined when it is set up with drilling. | |
| earlyAccessFeatures? | IEarlyAccessFeaturesConfig | (BETA) (Optional) Early access features configuration. | |
| enableAdDescriptionEdit? | boolean | (Optional) Enable editing of insight description in AD. | |
| enableADMultipleDateFilters? | boolean | (Optional) Enable multiple date filters in AD. | |
| enableAIFunctions? | boolean | (Optional) Enable GenAI-powered functionality, such as semantic-search. | |
| enableAlertAttributes? | boolean | (Optional) Enables attributes in alerts. | |
| enableAlerting? | boolean | (Optional) Enables alerting of the dashboard widgets. | |
| enableAlertingRollout? | boolean | (Optional) Enables alerting rollout of the dashboard widgets. | |
| enableAlternativeDisplayFormSelection? | boolean | (Optional) Indicates whether alternative display form can be selected for attribute and multiple instances of the same attributes can be put into buckets | |
| enableAnalyticalDashboardPermissions? | boolean | (Optional) Enable usage of Dashboard permissions | |
| enableAnalyticalDashboards? | boolean | (Optional) | |
| enableApproxCount? | boolean | (Optional) Indicates whether the approximate variant of count is available in AD. | |
| enableAttributeFilterValuesValidation? | boolean | (Optional) Enable attribute filter values validation by metric, attribute, fact. The configuration of filter values validation is merged with parent filters UI. | |
| enableAxisLabelFormat? | boolean | (Optional) Enable axis label formatting | |
| enableAxisNameConfiguration? | boolean | (Optional) Allows configuration of axis name position and visibility for Pluggable Visualizations. | |
| enableAxisNameViewByTwoAttributes? | boolean | (Optional) Enable axis name for the column, bar and bullet charts with view by two attributes. | |
| enableBulletChart? | boolean | (Optional) Indicates whether the Bullet Chart is available in AD. | |
| enableChartsSorting? | boolean | (Optional) Enable charts sorting customization | |
| enableClickableAttributeURL? | boolean | (Optional) Enable implicit drillToAttributeURL | |
| enableColumnHeadersPosition? | boolean | (Optional) Enable moving column attribute headers to the left. | |
| enableCompanyLogoInEmbeddedUI? | boolean | (Optional) Indicates whether the company logo should be visible in the embedded dashboard. | |
| enableCompositeGrain? | boolean | (Optional) Enable use of composite grain | |
| enableCreateUser? | boolean | (Optional) Enable creating users in user management. | |
| enableCsvUploader? | boolean | (Optional) | |
| enableCustomColorPicker? | boolean | (Optional) Indicates whether color picker config panel should allow users to select custom RGB colors. | |
| enableDashboardFilterViews? | boolean | (Optional) Enable multiple data sources to be used in a single workspace. | |
| enableDashboardFlexibleLayout? | boolean | (Optional) Enables new dashboard layout renderer with nesting support. | |
| enableDataSampling? | boolean | (Optional) Indicates whether backend supports data sampling. | |
| enableDataSection? | boolean | (Optional) | |
| enableDefaultSmtp? | boolean | (Optional) Enable the use of default SMTP in destinations. | |
| enableDescriptions? | boolean | (Optional) Enable usage of insights, widgets, kpis descriptions. | |
| enableDrilledInsightExport? | boolean | (Optional) Indicates whether the drilled insight can be exported. | |
| enableDuplicatedLabelValuesInAttributeFilter? | boolean | (Optional) Enable listing of the non-unique (duplicated) secondary label values in attribute filter. | |
| enableEarlyAccessFeaturesRollout? | boolean | (Optional) Enable early access features rollout. | |
| enableEmbedButtonInAD? | boolean | (Optional) Indicates whether the Embed button/dialog is available in AD. | |
| enableEmbedButtonInKD? | boolean | (Optional) Indicates whether the Embed dashboard button is available in KPI dashboards. | |
| enableFlightRpcDataSource? | boolean | (Optional) Enables the FlightRPC (FlexFunctions) data source. | |
| enableGenAIChat? | boolean | (Optional) Enable Gen AI Chatbot in UI. | |
| enableGenAIChatRollout? | boolean | (Optional) Enable Gen AI Chatbot rollout in UI. | |
| enableGranularPermissions? | boolean | (Optional) Enable the use of granular permissions. | |
| enableHeadlineExport? | boolean | (Optional) Enables manual headline exports on dashboard. | |
| enableHidingOfDataPoints? | boolean | (Optional) Indicates whether data point visibility configuration is available in AD | |
| enableHidingOfWidgetTitle? | boolean | (Optional) Enable hiding of widget title | |
| enableIgnoreCrossFiltering? | boolean | (Optional) Enables ignore cross-filtering in widgets on dashboard. | |
| enableInsightExportScheduling? | boolean | (Optional) Indicates whether the new UI for scheduled widget exports is enabled. | |
| enableInsightToReport? | boolean | (Optional) Setting to use Report instead of Insight in AD&KD | |
| enableInvalidValuesInAttributeFilter? | boolean | (Optional) Enable possibility to set non-existing value into attribute filter in AD and KD via postMessage. | |
| enableKDAttributeFilterDatesValidation? | boolean | (Optional) Enable attribute filter values validation by date filters. | |
| enableKDCrossFiltering? | boolean | (Optional) Enable cross filtering in KD | |
| enableKDRichText? | boolean | (Optional) Enables rich text widgets on dashboards. | |
| enableKDVisualizationSwitcher? | boolean | (Optional) Enables visualization switcher widgets on dashboards. | |
| enableKDWidgetCustomHeight? | boolean | (Optional) Indicates whether the user can change widget height in KPI dashboards. | |
| enableKDZooming? | boolean | (Optional) Indicates whether the user can zoom on the insights in KPI dashboards that have this feature enabled. | |
| enableKPIDashboardDrillFromAttribute? | boolean | (Optional) Enable drill from attributes | |
| enableKPIDashboardDrillToDashboard? | boolean | (Optional) Indicates whether the drill to dashboard is enabled. | |
| enableKPIDashboardDrillToInsight? | boolean | (Optional) Indicates whether the drill to insight is enabled. | |
| enableKPIDashboardDrillToURL? | boolean | (Optional) Indicates whether the drill to url is enabled. | |
| enableKPIDashboardImplicitDrillDown? | boolean | (Optional) Enable implicit drill down | |
| enableKPIDashboardSaveAsNew? | boolean | (Optional) Indicates whether the user can save and existing dashboard in KPI dashboards as new. | |
| enableKPIDashboardSchedule? | boolean | (Optional) Indicates whether dashboard scheduled mails are enabled. | |
| enableKPIDashboardScheduleRecipients? | boolean | (Optional) Indicates whether the user can select recipients of scheduled e-mails. If not, scheduled mail can only be sent to a logged in user. | |
| enableMariaDbDataSource? | boolean | (Optional) | |
| enableMotherDuckDataSource? | boolean | (Optional) | |
| enableMultipleCSVs? | boolean | (Optional) Enable upload of multiple CSVs to data source and multiple CSV data sources. | |
| enableMultipleDataSourcesInWorkspace? | boolean | (Optional) Enable multiple data sources to be used in a single workspace. | |
| enableMultipleDateFilters? | boolean | (Optional) Enable multiple date filters. | |
| enableMultipleDates? | boolean | (Optional) Indicates whether multiple dates can be put into buckets | |
| enableMySqlDataSource? | boolean | (Optional) | |
| enableNewHeadline? | boolean | (Optional) Indicates whether the Headline's improvements is available. | |
| enableNewNavigationForResponsiveUi? | boolean | (Optional) | |
| enableNumberSeparators? | boolean | (Optional) Enable number separators configuration in home-ui (both organization and workspace level). | |
| enableOracleDataSource? | boolean | (Optional) | |
| enablePivotTableIncreaseBucketSize? | boolean | (Optional) Enable new max bucket size items limit for Pivot Table | |
| enablePivotTableTransposition? | boolean | (Optional) Enable table transposition (metrics in rows) | |
| enablePixelPerfectExperience? | boolean | (Optional) | |
| enablePushpinGeoChart? | boolean | (Optional) Indicates whether the GeoPushpin Chart is available in AD. | |
| enableRenamingMeasureToMetric? | boolean | (Optional) Enable renaming measure to metric | |
| enableRenamingProjectToWorkspace? | boolean | (Optional) | |
| enableReversedStacking? | boolean | (Optional) Enable reverse the order of stacked items in bar chart. | |
| enableRichTextDescriptions? | boolean | (Optional) Enables rich text in descriptions. | |
| enableScatterPlotClustering? | boolean | (Optional) Enable clustering in scatter plot. | |
| enableScatterPlotSegmentation? | boolean | (Optional) Enables segmentation in scatter plot. | |
| enableScheduling? | boolean | (Optional) Enables scheduling of the dashboard pdf export. | |
| enableSemanticSearch? | boolean | (Optional) Enable Semantic Search in the UI. | |
| enableSemanticSearchRollout? | boolean | (Optional) Enable Semantic Search rollout in the UI. | |
| enableSeparateTotalLabels? | boolean | (Optional) Enable visibility control for total labels | |
| enableSingleStoreDataSource? | boolean | (Optional) | |
| enableSmtp? | boolean | (Optional) Enables smtp settings. | |
| enableSnowflakeKeyPairAuthentication? | boolean | (Optional) | |
| enableTableColumnsAutoResizing? | boolean | (Optional) Indicates whether PivotTable columns should be auto-resized to fit viewport before the table is shown to the user. | |
| enableTableColumnsGrowToFit? | boolean | (Optional) Indicates whether PivotTable should grow to fill all available, allocated space. | |
| enableTableColumnsManualResizing? | boolean | (Optional) Indicates whether PivotTable manual resizing should be persisted or not. | |
| enableUnavailableItemsVisible? | boolean | (Optional) Indicates whether unavailable data items are visible | |
| enableUserManagement? | boolean | (Optional) Enable user management page in Home UI. | |
| enableWaterfallChart? | boolean | (Optional) Indicates whether the Waterfall Chart is available in AD. | |
| enableWeekFilters? | boolean | (Optional) Indicates whether week filtering is available in AD. | |
| enableWidgetIdentifiersRollout? | boolean | (Optional) Enables storing widget identifiers. | |
| enableWorkspaceHierarchySettings? | boolean | (Optional) Enable configuration workspace hierarchy settings in Home UI. | |
| enableWorkspacesHierarchyView? | boolean | (Optional) Enable workspaces hierarchy view in Home UI. | |
| formatLocale? | string | (Optional) Locale code to use for date formatting. | |
| hideKpiDrillInEmbedded? | boolean | (Optional) Disables Kpi widget drills in embedded mode. | |
| hidePixelPerfectExperience? | boolean | (Optional) | |
| metadataTimeZone? | string | (Optional) IANA identifier of time zone in which the platform metadata are stored. | |
| openAiConfig? | IOpenAiConfig | (ALPHA) (Optional) Represents configuration for OpenAI integration | |
| platformEdition? | PlatformEdition | (Optional) Indicates current platform edition. | |
| responsiveUiDateFormat? | string | (Optional) Indicates the format in which the dates will be displayed | |
| showHiddenCatalogItems? | boolean | (Optional) Indicates whether unavailable data items are visible in the settings API only available on Tiger/Panther | |
| timezone? | string | (Optional) Timezone | |
| weekStart? | WeekStart | (Optional) Week start day | |
| whiteLabeling? | IWhiteLabeling | (Optional) Represents whiteLabeling configuration |