@gooddata/sdk-model
This package provides domain models for GoodData.UI.
Remarks
These domain models are backend-agnostic. This makes them reusable across different Analytical Backend implementations. The package includes TypeScript type definitions, factory functions, functions to get or set certain properties of the objects in an immutable way, and more. These are used in both the @gooddata/sdk-backend-* and @gooddata/sdk-ui* packages.
Classes
Class | Description |
|---|---|
Builder for arithmetic measures. Do not instantiate this builder directly, instead use newArithmeticMeasure(). | |
Builder for attributes. Do not instantiate this class directly. Instead use newAttribute() or modifyAttribute(). | |
Builder for inline measures. Do not instantiate this builder directly, instead use newMeasure() or modifyMeasure() functions. | |
Builder for simple measures. Do not instantiate this builder directly, instead use newMeasure() or modifyMeasure() functions. | |
Builder for period-over-period measures. Do not instantiate this builder directly, instead use newPopMeasure(). | |
Builder for previous period measures. Do not instantiate this builder directly, instead use newPreviousPeriodMeasure(). |
Abstract Classes
Abstract Class | Description |
|---|---|
Abstract base class for measure builders. Measure builders allow for incremental, fluent construction and modification of measures. |
Enumerations
Enumeration | Description |
|---|---|
Defines possible compute ratio sanitization rules. |
Functions
Function | Description |
|---|---|
Gets effective values of an absolute date filter. | |
Applies compute ratio rule to all measures in a list. | |
Returns a value indicating whether the two ObjRef instances are semantically equal (i.e. are of the same type and have the same value). Null and undefined are considered equal to each other. | |
Gets an attribute alias. | |
Returns local identifier of attribute described in the provided attribute descriptor. | |
Returns name of attribute described in the provided attribute descriptor. | |
Gets ObjRef of the attribute the display form is a form of. | |
Gets the attribute display form’s ObjRef | |
Gets the attribute display form’s title. | |
Gets an attribute display form object ref. | |
(ALPHA) Converts IAttributeFilter to DashboardAttributeFilterItem. | |
Gets identifier of attribute’s display form to use and get attribute element values from. | |
Gets local identifier of an attribute. | |
Given attribute locator, return the element that it references. | |
Given attribute locator, return the localId of attribute that it references. | |
Given list of attributes, returns first-found attribute matching the provided predicate. | |
Gets an attribute show all values property. | |
Gets URI of attribute’s display form to use and get attribute element values from. | |
(ALPHA) Whether a granularity is usable under the given calendar — its own ( | |
Gets first attribute matching the provided predicate from the bucket. | |
Gets the index of the first attribute matching the provided predicate from the bucket. | |
Gets all attributes matching the provided predicate from the bucket. | |
Tests whether the provided bucket is empty = contains no items and no totals. | |
Gets value of local identifier of bucketItem | |
Creates a new bucket by modifying items of the provided input bucket. | |
Gets all attributes and measures from the bucket. | |
Gets first measure matching the provided predicate from the bucket. | |
Gets the index of the first measure matching the provided predicate from the bucket. | |
Gets all measures matching the provided predicate from the bucket. | |
Creates a new bucket by modifying items of the provided input bucket. | |
Gets all attributes matching the provided predicate from a list of buckets. | |
Gets buckets with the provided local identifiers from a list of buckets. | |
Gets a new bucket that ‘inherits’ all data from the provided bucket but has different totals. | |
Finds bucket matching the provided predicate in a list of buckets. | |
Finds attribute matching the provided predicate in a list of buckets. | |
Finds measure matching the provided predicate in a list of buckets. | |
Tests whether all buckets in a list are empty (meaning neither has any items or totals defined) | |
Gets all attributes and measures from a list of buckets. | |
Gets all measures matching the provided predicate from a list of buckets. | |
Creates a new array of buckets, each bucket in the array contains modified bucket items (retrieved by applying the modifications function to the bucketItem). | |
Creates a new array of buckets, each bucket in the array contains modified bucket items | |
Gets all totals from a list of buckets | |
Gets all totals from the bucket | |
canCreateMetric(workspacePermissions, areMetricPermissionsEnabled) | (ALPHA) Effective CREATE capability for metrics in a workspace. |
canEditMetric(metricPermissions, workspacePermissions, areMetricPermissionsEnabled) | (ALPHA) Effective EDIT capability for a single metric. |
(ALPHA) Effective EDIT capability for a single visualization. | |
canShareMetric(metricPermissions, workspacePermissions, areMetricPermissionsEnabled) | (ALPHA) Effective SHARE capability for a single metric. |
(ALPHA) Effective SHARE capability for a single visualization. | |
(BETA) Adapts a catalog computed attribute to a catalog attribute so it can enter attribute-shaped resolution maps and listings. | |
Get metadata object that catalog item represents | |
Returns RGB code representing the color in the provided color palette items. | |
Returns a list of RGB color codes for all items in the provided color palette. | |
computedAttributeAsAttributeMetadataObject(computedAttribute) | (BETA) Adapts a computed attribute to the attribute metadata surface. |
(ALPHA) Returns the display form of any attribute-based dashboard filter. | |
(ALPHA) Returns the parent attribute filter dependencies of any attribute-based dashboard filter. Standard and arbitrary filters support parent filtering; match filters do not, so this returns undefined for match filters. | |
(ALPHA) Returns the dependent date filter dependencies of any attribute-based dashboard filter. Standard and arbitrary filters support dependent date filtering; match filters do not, so this returns undefined for match filters. | |
(ALPHA) Returns the local identifier of any attribute-based dashboard filter. | |
(ALPHA) Returns the title of any attribute-based dashboard filter. | |
(ALPHA) Converts any DashboardAttributeFilterItem to IAttributeFilter instance. | |
(ALPHA) Returns the validateElementsBy of any attribute-based dashboard filter. Standard and arbitrary filters support element validation; match filters do not, so this returns undefined for match filters. | |
Converts IDashboardAttributeFilter to IAttributeFilter instance. | |
dashboardDateFilterToDateFilterByDateDataSet(filter, dateDataSet) | Converts IDashboardDateFilter to IDateFilter instance. |
Converts IDashboardDateFilter to IDateFilter instance. | |
(ALPHA) Returns local identifier of the dashboard filter. | |
(ALPHA) Returns objRef of the dashboard filter. For attribute filters (including text mode filters), this will be reference to the display form. For date filters, it’s reference to the data set, or undefined if it’s the default date filter. For measure value filters, it’s reference to the metric. | |
(ALPHA) Gets reference to object being used for filtering. For attribute filters, this will be reference to the display form. For date filters this will be reference to the data set. For measure value filters this will be reference to the metric. | |
(ALPHA) Returns the local identifier of a dashboard measure value filter. | |
(ALPHA) Converts IDashboardMeasureValueFilter to IMeasureValueFilter instance. | |
Default dimension generator for execution definition behaves as follows: | |
Calculates fingerprint for the execution definition. | |
Creates new execution definition by slapping the provided dimensions on top of the definition. | |
Creates new execution definition by merging new exection configuration into an existing definition. | |
Creates new execution definition by setting a new post processing. | |
Creates new execution definition by merging new sort items into an existing definition. | |
Gets totals from particular dimension in the provided execution definition. | |
Changes the dateFormat of a postProcessing, other properties of postProcessing (if any) remain unchanged. | |
Configures dimensions in the exec definition. | |
Changes additional execution configuration in the definition. | |
Creates new execution definition by merging new filters into an existing definition. | |
Changes the postProcessing of a definition. | |
Changes sorting in the definition. Any sorting settings accumulated so far WILL be wiped out. | |
Deserializes an ObjRef from its pure string representation. | |
Creates a new dimension which has same items as the provided dimension but different totals. | |
Looks for item with the provided local identifier among the dimensions. | |
Gets totals defined in the provided dimension | |
Disables compute ratio if set on a simple measure. Does not do anything for other measures. | |
(ALPHA) Returns the attribute or date dataset attribute reference for the provided drill down reference. | |
(ALPHA) Returns the attribute hierarchy reference for the provided drill down reference. | |
Creates new, empty execution definition for the provided workspace. | |
(ALPHA) Evaluates a Condition against an actual value object. | |
(ALPHA) Returns semantic kind for a known execution result limit type. | |
(ALPHA) Gets the date when the exportDefinition was created | |
(ALPHA) Gets the exportDefinition title | |
(ALPHA) Gets the date of the last exportDefinition update | |
Returns a code for generating the provided input using convenience factory methods where possible. | |
Gets attribute elements specified on the attribute filter. | |
Gets attribute elements specified on a filter. If the provided filter is not an attribute filter, then undefined is returned | |
filterContextItemsToDashboardFiltersByDateDataSet(filterContextItems, dateDataSet) | (ALPHA) Gets IDashboardFilter items for filters specified as FilterContextItem instances. |
filterContextItemsToDashboardFiltersByRichTextWidget(filterContextItems, widget) | (ALPHA) Gets IDashboardFilter items for filters specified as FilterContextItem instances. |
filterContextItemsToDashboardFiltersByWidget(filterContextItems, widget) | (ALPHA) Gets IDashboardFilter items for filters specified as FilterContextItem instances. |
filterContextToDashboardFiltersByDateDataSet(filterContext, dateDataSet) | (ALPHA) Gets IDashboardFilter items for filters specified in given filterContext in relation to the given dateDataSet. |
filterContextToDashboardFiltersByWidget(filterContext, widget) | (ALPHA) Gets IDashboardFilter items for filters specified in given filterContext in relation to the given widget. |
Tests whether the provided attribute element does not specify any attribute elements. | |
Gets local identifier of filter. | |
Gets reference to a measure being used for filtering if the provided filter is measure based. For other filters return undefined. | |
Gets reference to object being used for filtering. | |
Gets reference to object being used for filtering. | |
(ALPHA) Returns id of the geo feature. | |
Resolves geo layer type from root insight visualization type. | |
(ALPHA) Chronological granularity a generic one is derived from (month_in_year → month), if any. | |
(ALPHA) Resolves a delimiter character to its corresponding preset identifier. Returns | |
(ALPHA) Resolves a delimiter value into its preset identifier and custom delimiter components. Maps the delimiter to a preset when possible, otherwise sets the preset to | |
(ALPHA) Validates a custom delimiter string and returns the first validation error, or | |
(ALPHA) Returns the actual delimiter character for a given preset selection. When the preset is | |
(ALPHA) Runs getGranularities() and narrows the result to the DateFilterGranularity subset. | |
(ALPHA) Fiscal equivalent of a standard granularity (year → fiscal_year), if any. | |
(ALPHA) The single source of truth for “which date granularities apply here”. | |
(ALPHA) Returns the descriptor for a granularity, or | |
(ALPHA) Returns the allowed values enumerated by the parameter definition, or | |
(ALPHA) Returns the | |
(ALPHA) Returns the title to show for | |
(ALPHA) Composes the URL under which the given pluggable application is reachable. | |
(ALPHA) Resolves the application’s title in the given locale. | |
(ALPHA) Collects the distinct | |
(ALPHA) Collects the distinct | |
(ALPHA) The path of a theme reference such as | |
(ALPHA) Returns count of selected elements | |
(ALPHA) Standard equivalent of a fiscal granularity (fiscal_year → year), if any. | |
Checks if measure value filter has conditions. | |
Factory function for attribute predicate which evaluates true for attributes that match particular ID. | |
Factory function for predicates that will evaluate true if bucket’s id is same as the provided id. | |
Factory function for measure predicate which evaluates true for measures that match particular ID. | |
Creates an IdentifierRef from object identifier and given object type. | |
Gets attribute filters configs used in an insight if defined. | |
Gets all attributes used in the provided insight | |
Finds bucket matching the provided predicate in an insight. | |
Gets buckets for the insight. If ids are provided, then only returns buckets matching the ids. | |
Gets the date when the insight was created | |
Gets the user that created the insight | |
(BETA) | |
(BETA) | |
Gets references to all display forms used by the insight. | |
Gets filters used in an insight. | |
Tests whether insight uses any attributes | |
Tests whether insight contains valid definition of data to visualise - meaning at least one attribute or one measure is defined in the insight. | |
Tests whether insight uses any measures. | |
Gets the insight id | |
(ALPHA) Checks if insight is hidden | |
Checks if insight is locked | |
Gets all attributes and measures used in the provided insight. | |
(ALPHA) Gets layers from insight definition. | |
Gets all measures used in the provided insight. | |
Creates a new insight with modified bucket items (retrieved by applying the modifications function to each bucketItem in the insight). | |
(ALPHA) Gets parameter values defined on an insight. | |
Gets visualization properties of an insight. | |
Creates a new insight with reduced bucket items (retrieved by applying the modifications function). | |
Gets opaque reference to the insight. | |
Makes sure the insight does not have any nonsensical data (like totals that no longer make sense, etc.), before it is saved. | |
Gets a new insight that ‘inherits’ all data from the provided insight but has different buckets. | |
Gets a new insight that ‘inherits’ all data from the provided insight but has different filters. | |
(ALPHA) Gets a new insight that ‘inherits’ all data from the provided insight but has different layers. | |
(ALPHA) Gets a new insight that ‘inherits’ all data from the provided insight but has different parameter values. | |
Gets a new insight that ‘inherits’ all data from the provided insight but has different properties. | |
Gets a new insight that ‘inherits’ all data from the provided insight but has different sorts. | |
Gets sorting defined in the insight. | |
Gets the insights summary | |
Gets the insights tags from the tagging system | |
Gets the insight title | |
(BETA) | |
Gets all totals defined in the insight | |
Gets the date of the last insight update | |
Gets the user that last updated the insight | |
(BETA) | |
(BETA) | |
Gets the insight uri | |
(ALPHA) | |
Gets URL of visualization that should be used to render this insight. This is a link to the location where the visualization assets are stored and where they should be loaded and linked from. Note: at the moment, the SDK supports only compile-time linkage; for this the visualization URL is in format “local:visName” (as in “local:bar” for BarChart) | |
(ALPHA) Returns true when given date filter has type set to absolute. | |
Type guard checking whether the provided object is an absolute date filter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IAbsoluteDateFilterForm. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IAbsoluteDateFilterPreset. | |
Type guard for checking whether object is an adhoc measure. | |
Type guard to check if the notification is an alert notification. | |
(ALPHA) Type-guard testing whether the provided object is an “All” dashboard measure value filter — a no-op MVF with no effective conditions (undefined or empty array). Such filters do not restrict execution and are typically stripped from stored filter contexts. | |
(ALPHA) Type-guard testing whether the provided object is an All time dashboard date filter. | |
(ALPHA) Type-guard testing whether the provided object is an All time dashboard date filter with | |
Type guard checking whether the provided object is an all time date filter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IAllTimeDateFilterOption. | |
Type guard checking whether the provided object is an all time date filter with | |
(ALPHA) Type-guard testing whether the provider object is an All values attribute filter | |
(ALPHA) Type guard checking whether the provided object is an arbitrary attribute filter. | |
Type guard for checking whether object is an arithmetic measure. | |
Type guard for checking whether object is an arithmetic measure definition. | |
(ALPHA) Type guard to check if a value is an AssignedWorkspacePermission. | |
Type guard checking whether object is an instance of IAttribute. | |
Type guard checking whether an object is an attribute area sort item. | |
Type-guard testing whether the provided object is an instance of IAttributeDescriptor. | |
Tests whether the provided object is of type IAttributeDisplayFormMetadataObject. | |
Type guard checking whether the provided object is list of attribute elements specified by URI reference. | |
Type guard checking whether the provided object is list of attribute elements specified by their text value. | |
Type guard checking whether the provided object is an attribute filter. | |
Type guard checking whether the provided object is an attribute filter with selection by elements. | |
Tests whether the provided object is of type IAttributeHierarchyMetadataObject. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IAttributeHierarchyReference. | |
Type guard checking whether an object is an attribute locator. | |
Tests whether the provided object is of type IAttributeMetadataObject. | |
Type guard checking whether an object is an attribute sort item. | |
Type guard checking whether an object is a normal attribute value sort item, not the area one. | |
(ALPHA) Type guard checking if the object is of type IAutomationExternalRecipient. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Type guard checking if the object is of type IAutomationExternalRecipient. | |
(ALPHA) Type guard checking if the object is of type IAutomationUserGroupRecipient. | |
(ALPHA) Type guard checking if the object is of type IAutomationUserRecipient. | |
(ALPHA) Tests whether the provided object is an instance of IAvailableUserAccessGrantee. | |
(ALPHA) Tests whether the provided object is an instance of IAvailableUserGroupAccessGrantee. | |
(ALPHA) Tests whether the provided timezone value is the BROWSER_DETECTED sentinel. | |
Type-guard testing whether the provided object is an instance of IBucket. | |
Type guard checking whether the provided object is a ICatalogAttribute | |
Type guard checking whether the provided object is a ICatalogAttributeHierarchy. | |
Type guard checking whether the provided object is a ICatalogComputedAttribute | |
Type guard checking whether object is an instance of ICatalogDateDataset. | |
Type guard checking whether object is an instance of ICatalogDateDataset. | |
Type guard checking whether the provided object is a ICatalogFact | |
Type guard checking whether the provided object is a ICatalogMeasure | |
(ALPHA) | |
Type-guard testing whether the provided object is an instance of IColorDescriptor. | |
Type guard checking whether the provided object is a IColorFromPalette | |
Type guard checking whether the provided object is an IColorMappingItem. | |
Type guard checking whether the provided object is a IColorPaletteItem | |
Type guard checking whether the provided object is a measure value filter’s comparison condition. | |
Type guard checking whether the provided operator is a measure value filter’s comparison operator. | |
Tests whether the attribute is a computed attribute. | |
Tests whether the provided object is of type IComputedAttributeMetadataObject. | |
Tests whether the provided object is of type IComputedAttributeMetadataObjectDefinition. | |
Type guard checking whether the object is an Identifier Reference pointing at a computed attribute. | |
(ALPHA) Type-guard testing whether the provided object is an instance of ICrossFiltering. | |
(ALPHA) Tests whether the provided object is an instance of IDashboard. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardArbitraryAttributeFilter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardAttachment. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardAttributeFilter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of DashboardAttributeFilterItem. | |
Type-guard testing whether the provided object is an instance of IDashboardAttributeFilterReference. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardDateFilter without date dataSet (aka dimension) defined. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardDateFilter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardDateFilterReference. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardDateFilter with date dataSet (aka dimension) defined. | |
(ALPHA) Tests whether the provided object is an instance of IDashboardDefinition. | |
Type-guard testing whether the provided object is an instance of IDashboardFilter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardLayout. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardLayoutItem. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardLayoutSection. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardMatchAttributeFilter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardMeasureValueFilter. | |
Type-guard testing whether the provided object is an instance of IDashboardMeasureValueFilterReference. | |
Tests whether the provided object is of type IDashboardMetadataObject. | |
(ALPHA) Tests whether the provided object is an instance of IDashboardParameter. | |
(ALPHA) Tests whether the provided object is an instance of IDashboardTab. | |
(ALPHA) Type-guard testing whether the provided object is a text mode attribute filter (IDashboardArbitraryAttributeFilter or IDashboardMatchAttributeFilter). | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardWidget. | |
Tests whether the provided object is of type IDataSetMetadataObject. | |
Type guard checking whether the provided object is a date filter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of DateFilterGranularity. | |
Type guard checking whether the provided object is a date filter with | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDateHierarchyReference. | |
Type guard checking whether object is of IDimension type. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillFromAttribute. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillFromMeasure. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillToAttributeUrl. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillToCustomUrl. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillToDashboard. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillToInsight. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IDrillToLegacyDashboard. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IEmptyValuesDateFilterOption. | |
(ALPHA) Type guard to check if the object is of type IExportDefinitionDashboardRequestPayload. | |
(ALPHA) Type guard to check if the object is of type IExportDefinitionVisualizationObjectRequestPayload. | |
(ALPHA) Type guard for ExternalPluggableApplicationRegistryItem | |
Tests whether the provided object is of type IFactMetadataObject. | |
Type guard checking whether the provided object is a filter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IFilterContext. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IFilterContextDefinition. | |
(ALPHA) Type-guard testing whether the provided object is an instance of FilterContextItem. | |
(ALPHA) | |
(ALPHA) | |
Type guard for geo layer type. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserAccess or IGranularUserGroupAccess. | |
(ALPHA) Tests whether the provided object is an instance of IGranularAccessGrantee. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserGroupAccessGrantee. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserAccess. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserAccessGrantee. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserAccess. | |
(ALPHA) Tests whether the provided object is an instance of IGranularUserGroupAccessGrantee. | |
Type guard checking whether object is an Identifier Reference. | |
Type guard for checking whether object is a inline measure. | |
Type guard for checking whether object is a inline measure definition. | |
Type guard checking whether the provided object is an Insight. | |
(ALPHA) Type guard to check if an object is IInsightLayerDefinition | |
(ALPHA) Type-guard testing whether the provided object is an instance of IInsightWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IInsightWidgetDefinition. | |
(ALPHA) Test if provided object is of IOrganizationUser type | |
(ALPHA) Test if provided object is of IOrganizationUser type | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKeyDriveAnalysis. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKpi. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKpiWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKpiWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKpiWithComparison. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IKpiWithoutComparison. | |
(ALPHA) Tests whether the provided object is an instance of IListedDashboard. | |
Type-guard for language codes that can be used with GoodData. | |
Type guard checking whether object is a localId Reference. | |
(ALPHA) Type guard for LocalPluggableApplicationRegistryItem | |
Type guard checking whether the provided object is a lower bounded filter. | |
(ALPHA) Type guard checking whether the provided object is a match attribute filter. | |
(BETA) Type guard checking whether input is an instance of IMdObject. | |
(BETA) Type guard checking whether input is an instance of IMdObjectDefinition. | |
Type guard for checking whether object is any type of measure. | |
Type guard for checking whether object is a measure definition. | |
Type-guard testing whether the provided object is an instance of IMeasureDescriptor. | |
Gets a flag indicating whether a given measure has a format resulting in data being formatted as percentage | |
Type-guard testing whether the provided object is an instance of IMeasureGroupDescriptor. | |
Determine if a given item is a measure group. | |
Type guard checking whether an object is measure locator | |
Tests whether the provided object is of type IMeasureMetadataObject. | |
Tests whether the provided object is of type IMeasureMetadataObjectDefinition. | |
Type guard checking whether an object is a measure sort item. | |
Type guard checking whether the provided object is a measure value filter. | |
Type guard checking whether input is an instance of IMetadataObject. | |
Type guard checking whether the provided object is a negative attribute filter. | |
(ALPHA) Returns true when given filter has negative selection | |
Helper function checking whether the provided filter has negative meaning. | |
(ALPHA) Type-guard testing whether the provided object is a noop “All time” dashboard date filter. | |
Type guard checking whether the provided object is a noop “all time” date filter. | |
Type guard to check if the notification is a test notification. | |
(BETA) Type guard checking whether input is an instance of INotificationChannelMetadataObject. | |
(BETA) Type guard checking whether input is an instance of INotificationChannelMetadataObjectDefinition. | |
(ALPHA) Tests whether the provided parameter definition is a INumberParameterDefinition. | |
(ALPHA) Tests whether the provided value is an ObjectPermissionsObjectKind. | |
Type guard checking whether object is an Identifier Reference or an URI reference. | |
Tests whether the provided object is of type IParameterMetadataObject. | |
Tests whether the provided object is of type IParameterMetadataObjectDefinition. | |
Type guard for checking whether object is a period-over-period measure. | |
Type guard for checking whether object is a period-over-period measure definition. | |
Type guard checking whether the provided object is a positive attribute filter. | |
Type guard for checking whether object is a previous-period measure. | |
Type guard for checking whether object is a previous period measure definition. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherColorBackgroundV1. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherDocumentContentV1. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherDocumentDefinitionV1. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherDocumentTemplateDefinitionV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherDocumentTemplateV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherDocumentV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherHeadingSlotV1. | |
(ALPHA) Type-guard testing whether the value is a PublisherHeadingTypeV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherImageBackgroundV1. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherImageSlotV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherLayoutSectionV1. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherLayoutSlotRefV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided value is a PublisherPageFormatV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherPageTemplateContentV1. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherPageTemplateDefinitionV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherPageTemplateV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherParagraphSlotV1. | |
(ALPHA) Type-guard testing whether the value is a PublisherParagraphTypeV1. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of PublisherSlotV1. | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherTextSlotV1. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Type-guard testing whether the provided object is an instance of IPublisherVisualizationSlotV1. | |
(ALPHA) | |
(ALPHA) | |
Type guard checking whether the provided object is a measure value filter’s range condition. | |
Type guard checking whether the provided object is a measure value filter’s range condition operator. | |
Type guard checking whether the provided object is a ranking filter. | |
Type guard checking whether the provided object is a relative date filter with bounded. | |
Type guard checking whether the provided object is a relative date filter body with bounded. | |
(ALPHA) Returns true when given date filter has type set to relative. | |
Type guard checking whether the provided object is a relative date filter. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IRelativeDateFilterForm. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IRelativeDateFilterPreset. | |
Type guard checking whether the provided filter is a relative date filter with lower bounded. | |
Type guard checking whether the provided filter body has a bounded filter with lower bounded. | |
Type guard checking whether the provided filter is a relative date filter with upper bounded. | |
Type guard checking whether the provided filter body has a bounded filter with upper bounded. | |
(ALPHA) Type guard for RemotePluggableApplicationRegistryItem | |
Type-guard testing whether the provided object is an instance of IResultAttributeHeader. | |
Type-guard testing whether the provided object is an instance of IResultMeasureHeader. | |
Type-guard testing whether the provided object is an instance of IResultTotalHeader. | |
Type guard checking whether the provided object is a IRgbColor | |
(ALPHA) Type-guard testing whether the provided object is an instance of IRichTextWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IRichTextWidgetDefinition. | |
Type guard to check if the notification is a schedule notification. | |
isSemanticConditionalFormattingEnabled(conditionalFormatting) | (ALPHA) Whether semantic-layer conditional formatting applies; an absent |
(BETA) Tests whether the provided item is a semantic search relationship. | |
(BETA) Tests whether the provided item is a semantic search result item. | |
Determines whether the given object is an instance of ISeparators. | |
(ALPHA) | |
Type guard for checking whether object is a simple measure. | |
Type guard checking whether the provided object is a positive attribute filter. | |
(ALPHA) Returns true when given filter has selection mode set to single | |
(ALPHA) | |
(ALPHA) Tests whether the provided parameter definition is a IStringParameterDefinition. | |
(ALPHA) Type-guard testing whether the provided object is an instance of ITempFilterContext. | |
Type guard to check if the notification is a test notification. | |
(ALPHA) Type guard checking whether the provided object is a text attribute filter (IArbitraryAttributeFilter or IMatchAttributeFilter). | |
(ALPHA) Type-guard testing whether the value is a IThemeColorPaletteRef. | |
(ALPHA) | |
Type-guard checking whether an object is a Total. | |
Type-guard testing whether the provided object is an instance of ITotalDescriptor. | |
Type guard checking whether an object is a total locator. | |
Type guard checking whether the provided object is an upper bounded filter. | |
Type guard checking whether object is an URI Reference. | |
(ALPHA) Tests whether the provided object is an instance of IUserAccess. | |
Tests whether the provided object is an instance of IUserAccessGrantee. | |
(ALPHA) Type guard for IUserDataFilter — a filter assigned to a specific user. | |
(ALPHA) Tests whether the provided object is an instance of IUserGroupAccess. | |
Tests whether the provided object is an instance of IUserGroupAccessGrantee. | |
(ALPHA) Type guard for IUserGroupDataFilter — a filter assigned to a user group. | |
(ALPHA) Tests whether the provided object is an instance of IUserWorkspaceAccessGrantee. | |
(ALPHA) Tests whether the provided object is an instance of IUserWorkspaceAccessGrantee. | |
(ALPHA) Tests whether a dashboard timezone value is allowed in dashboard content: BROWSER_DETECTED, or a valid IANA timezone ID. | |
(ALPHA) Tests whether Identifiers are case-sensitive. | |
(ALPHA) Tests whether | |
(ALPHA) Tests whether | |
(ALPHA) Tests whether | |
Tests whether the provided object is of type IVariableMetadataObject. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IVisualizationSwitcherWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IVisualizationSwitcherWidgetDefinition. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IWidget. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IWidgetAlert. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IWidgetAlertDefinition. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IWidgetAttachment. | |
(ALPHA) Type-guard testing whether the provided object is an instance of IWidgetDefinition. | |
(ALPHA) Type-guard testing whether the provided object is a widget that can store dashboard filter settings. | |
Creates an LocalIdRef from a local identifier | |
Gets measure aggregation from a measure. | |
Gets measure alias. | |
Gets identifiers of arithmetic operands from the provided arithmetic measure. | |
Gets identifiers of arithmetic operands from the provided measure. If the measure is not an arithmetic measure, then undefined is returned. | |
Gets arithmetic operator from the provided arithmetic measure. | |
Gets arithmetic operator from the provided measure. | |
Tests whether the measure is set to compute ratio. | |
Gets measure filters. | |
Gets measure format. | |
Gets identifier of persistent measure. | |
Gets reference of LDM object from which the measure is calculated (fact or MAQL metric). | |
Gets reference of LDM object from which the measure is calculated (fact or MAQL metric). | |
Gets measure’s local identifier. For convenience and fluency, this function accepts both measure object and identifier object. | |
Given measure locator, return the localId of measure that it references. | |
Gets identifier of master measure for the provided PoP measure or Previous Period measure. | |
Gets identifier of master measure for the provided derived measure (PoP measure or Previous Period measure). | |
Gets attribute used for period-over-period measure calculation. | |
Gets attribute used for period-over-period measure calculation. | |
Gets date data sets used in previous-period measure. | |
Gets date data sets used in previous-period measure. | |
Gets measure title. | |
Gets URI of persistent measure. | |
Gets measure value filter condition. Provides only legacy condition property. | |
Gets measure value filter conditions. | |
Gets measure value filter dimensionality. | |
Gets measure value filter measure. | |
Gets operator used in measure value filter condition. | |
Gets operators used in measure value filter conditions. Supports both legacy single condition and new multiple conditions format. | |
Get metadata object identifier | |
Allows modification of an existing attribute instance. | |
Creates a new inline measure by applying modifications on top of an existing measure. | |
Creates a new measure by applying modifications on top of an existing measure. | |
Creates a new PoP measure by applying modifications on top of an existing measure. | |
Creates a new Previous Period measure by applying modifications on top of an existing measure. | |
Creates a new simple measure by applying modifications on top of an existing measure. | |
newAbsoluteDashboardDateFilter(from, to, dataSet, localIdentifier, emptyValueHandling, granularity) | (ALPHA) Creates a new absolute dashboard date filter. |
Creates a new absolute date filter. | |
newAbsoluteDateFilter(dateDataSet, from, to, localIdentifier, emptyValueHandling) | Creates a new absolute date filter. |
newAdHocPublisherDocumentDefinitionV1(options, modifications) | (ALPHA) Creates an ad-hoc document definition not based on any template. |
newAllTimeDashboardDateFilter(dataSet, localIdentifier, emptyValueHandling) | (ALPHA) Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the dates. |
newAllTimeFilter(dateDataSet, localIdentifier, emptyValueHandling) | Creates a new all time date filter. This filter is used to indicate that there should be no filtering on the given date data set. |
newArbitraryAttributeFilter(attributeOrRef, values, negativeSelection, localIdentifier) | (ALPHA) Creates a new arbitrary attribute filter. |
newArithmeticMeasure(measuresOrIds, operator, modifications) | Creates a new arithmetic measure with the specified measure identifiers and operator and optional modifications and localIdentifier. |
Creates a new attribute with the specified display form ref and optional modifications and localIdentifier. | |
newAttributeAreaSort(attributeOrId, sortDirection, aggregation) | Creates a new attribute area sort - sorting the result by aggregated measure values belonging to each attribute value included in the result. |
Creates a new attribute locator for an attribute element. | |
Creates a new attribute locator for an attribute element that can be null. | |
Creates a new attribute sort - sorting the result by values of the provided attribute’s elements. | |
Creates a new bucket with the provided id and all the specified content. | |
Prepares a new execution definition for a list of buckets. | |
Prepares a new execution definition for the provided insight. | |
Prepares a new execution definition for a list of attributes and measures, filtered using the provided filters. | |
Creates new single-dimensional specification where the dimension will have the provided set of identifiers. | |
Creates a new inline measure | |
newMatchAttributeFilter(attributeOrRef, operator, literal, options, localIdentifier) | (ALPHA) Creates a new match attribute filter. |
Creates a new measure with the specified identifier and optional modifications and localIdentifier. | |
newMeasureSort(measureOrId, sortDirection, attributeLocators) | Creates a new measure sort - sorting the result by values of the provided measure. |
Creates a new measure sort - sorting the result by values of the provided measure. | |
newMeasureValueFilter(measureOrRef, operator, value, treatNullValuesAs) | Creates a new measure value filter. |
newMeasureValueFilter(measureOrRef, operator, from, to, treatNullValuesAs) | Creates a new measure value filter. |
Creates a new measure value filter with options object. | |
newNegativeAttributeFilter(attributeOrRef, notInValues, localIdentifier) | Creates a new negative attribute filter. |
newPopMeasure(measureOrLocalId, popAttrIdOrRef, modifications) | Creates a new PoP measure with the specified identifier and PoP attribute identifier and optional modifications and localIdentifier. |
newPositiveAttributeFilter(attributeOrRef, inValues, localIdentifier) | Creates a new positive attribute filter. |
newPreviousPeriodMeasure(measureIdOrLocalId, dateDataSets, modifications) | Creates a new Previous Period measure with the specified measure identifier and date data sets and optional modifications and localIdentifier. |
(ALPHA) Creates document content from page instances. | |
newPublisherDocumentDefinitionFromTemplateV1(template, options, modifications) | (ALPHA) Creates a document definition from a template. |
(ALPHA) Generates a document filter id such as | |
newPublisherDocumentPageFromTemplateV1(page, localIdentifier) | (ALPHA) Clones a page template into a page instance embeddable in template/document content. |
(ALPHA) Copies a page template’s content into a new document page. | |
newPublisherDocumentTemplateDefinitionV1(title, content, modifications) | (ALPHA) Creates a new document template definition. |
(ALPHA) Generates an id such as | |
(ALPHA) Generates a page id such as | |
newPublisherPageTemplateDefinitionV1(title, body, modifications) | (ALPHA) Creates a new page template definition. |
(ALPHA) Generates a section id such as | |
(ALPHA) Generates a widget id such as | |
newRankingFilter(measureOrRef, attributesOrRefs, operator, value) | Creates a new ranking filter. |
Creates a new ranking filter. | |
(ALPHA) Creates a new relative dashboard date filter. | |
Creates a new relative date filter. | |
Creates a new total. | |
Creates new two dimensional specification where each dimension will have the provided set of identifiers. | |
(ALPHA) Normalizes a dashboard timezone configuration to its canonical shape: unset and default (false/empty) properties are dropped, and a configuration with no effective values collapses to undefined. Apply before storing the configuration in state or persisting it, so that “all defaults” is always represented as an absent configuration rather than an empty object. | |
Retrieves string representation of object reference. This is purely for for representation of references in text, debug and tests. | |
(ALPHA) Tests whether | |
(ALPHA) Returns the sections of document content. Content stored as | |
publisherDocumentContentSetSectionsV2({ content, sections, }, input) | (ALPHA) Writes sections back into document content, in the shape the content was read in. |
publisherDocumentPageV1(documentOrTemplate, pageLocalIdentifier) | (ALPHA) Convenience accessor for a document or template page by its localIdentifier. |
(ALPHA) Text style a heading uses when its style sets none: | |
(ALPHA) The marker referencing the named variable from document text. | |
(ALPHA) The marker referencing the variable from document text. | |
(ALPHA) Sizes the slot can be rendered at, which is what its own type decides. | |
(ALPHA) Size the slot is rendered at. | |
(ALPHA) The theme reference to the path, such as | |
Gets effective values of a relative date filter. | |
(ALPHA) Replaces | |
(ALPHA) Replaces | |
(ALPHA) Resolves a dashboard timezone value to a concrete IANA timezone ID: the BROWSER_DETECTED sentinel resolves to the browser/runtime timezone, any other value is returned as-is. This is the only supported way to turn IDashboardTimezoneConfig.timezoneId into a value usable in executions or exports — the sentinel must never leave the client unresolved. | |
(ALPHA) Resolves the effective week start day from platform settings. | |
Returns item name contained within a result header. | |
(ALPHA) Returns | |
Serializes an instance of ObjRef to a string representation. | |
Gets sort item’s direction | |
Given sort item, returns ids of entities (objects) that are referenced by the sort item. | |
Given a measure sort item, return the locators which identify the measure (possibly scoped for particular attribute element). | |
(ALPHA) Converts the full workspace permissions (as returned by the backend SPI) to the reduced set used by the pluggable application manifest. | |
Tests whether total instance represents a native total = a roll-up total. | |
Creates an UriRef from an URI | |
Gets the user full name | |
(ALPHA) Validates the content of a document or a document template: every key, value and node type, exactly one of | |
(ALPHA) Validates a document, document template or page template, as a definition or as a persisted object: everything its content validator checks, | |
(ALPHA) Validates the structural invariants of a page body beyond what its types guarantee for content arriving from the wire: the page format is known, slot localIdentifiers are unique, layout weights are positive, corner radii and paddings are finite and not negative, every slot is placed (by the layout, or as the image background of a box that renders), every layout slotId resolves (unresolved ones are warnings — they render as empty areas), and background references resolve to image slots. | |
(ALPHA) Validates a page body, such as a page template’s content: every key, value and node type, at most one title widget, and widget ids unique in the page. | |
For given visualization class, return its identifier. | |
For given visualization class, return its URI. | |
For given visualization class, return URL where the vis assets are stored. | |
(ALPHA) Gets the widget identifier | |
(ALPHA) Gets the widget ref | |
Gets the widget title | |
(ALPHA) Gets the widget type | |
(ALPHA) Gets the widget uri |
Interfaces
Interface | Description |
|---|---|
Filters results to an absolute date range - from one fixed date to another. | |
Object defining the IAbsoluteDateFilter object body. | |
(ALPHA) Customized options for the global absolute date filter | |
Options of a new absolute date filter. | |
(ALPHA) Custom absolute date filter preset | |
Represents values of an absolute filter. | |
(ALPHA) Common properties for objects with controlled access | |
Active calendars configuration | |
(ALPHA) Represents an AI agent entity. | |
(ALPHA) A rule an agent follows when answering, such as a business definition or how to handle a kind of request. Carried inside IAgent.instructions. Instructions have no identifier: they live and die with their agent, and the backend addresses them by position. Writing an agent replaces its whole list. | |
(ALPHA) Represents a single skill available to the AI agent. | |
AI rate limit configuration. Caps how many AI chat messages a user can send within a rolling time window. | |
Alert Default | |
Alert description. | |
Alert evaluation row. | |
Metric value. | |
Notification with details about the alert that triggered it. | |
Details of the alert notification. | |
(BETA) Allowed relationship type combination for semantic search. Filters relationships and results to only include direct matches or objects reachable via allowed relationship types. | |
(ALPHA) Customized options for the global all time date filter | |
Analytical Widgets are a sub-type of dashboard widgets that display analytics. Be it charts rendering insights (reports) or KPIs rendering measure values optionally with their comparison. | |
(ALPHA) | |
Arbitrary attribute filter - allows filtering by custom string values that may not exist as attribute elements. | |
Object defining the IArbitraryAttributeFilter object body. | |
Arithmetic measures are created by composing two or more other measures and defining arithmetic to apply on their values. | |
(ALPHA) Information about assigned data source. | |
(ALPHA) Information about assigned workspace. | |
Attribute is our nomenclature for ‘dimension’ as typically used in multi-dimensional BI modeling. | |
Attribute is our nomenclature for ‘dimension’ as typically used in multi-dimensional BI modeling. | |
Describes attribute slicing of a dimension. | |
Attribute descriptor header. | |
(ALPHA) Additional configuration for geo area display forms. | |
Attribute display form metadata object | |
Attribute element represented by concrete display form | |
Attribute elements specified by their URI. | |
Attribute elements specified by their textual value. | |
Describes attributes to which the display form belongs. | |
Attribute hierarchy metadata object. | |
(ALPHA) | |
Locator that specifies a concrete attribute element for which the measure values are sliced. | |
Locator that specifies a concrete attribute element for which the measure values are sliced. | |
Attribute metadata object | |
Sort item which specifies that the result should be sorted by attribute element values in either ascending or descending order. | |
Attribute sort target. | |
Attribute sort type specification. | |
Object that can provide information about the users that created or modified it and when those actions occurred. | |
Object that can provide information about the users that created or modified it and when those actions occurred. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
Notification with details about the automation or test that triggered it. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) User grantee that is available as target for granting of a permission to shared object. | |
(ALPHA) User group grantee that is available as target for granting of a permission to shared object. | |
(ALPHA) | |
(ALPHA) | |
Base type for dashboard widgets. | |
Bucket is a logical, user-defined grouping of attributes, measures and totals. | |
Type representing catalog attribute | |
Type representing catalog attribute hierarchy. | |
Type representing catalog computed attribute. | |
Type representing catalog dateDataset date attribute | |
Type representing catalog date dataset | |
Type representing catalog fact | |
Catalog group can be used to group catalog items | |
Properties contained in each catalog item | |
Type representing catalog measure | |
Describes color included in a dimension. | |
Describes color included in a dimension. | |
Color defined by referencing an item in the user-defined color palette. | |
An item in color mapping definition for an insight. The color mapping is stored in properties of those insights that can be colored AND have color mapping specified by the user. | |
(ALPHA) Color palette definition represents modified or created theme | |
An item in user-defined color palette. Item is essentially mapping of user-assigned color identifier to an RGB Color value. | |
(ALPHA) Color palette metadata object | |
(ALPHA) Conditional-formatting settings: an on/off toggle plus the ordered list of rules. Stored on the table config and (when persisted) on the insight’s | |
(ALPHA) A single condition: an operator + operand, and the format applied when it matches. | |
(ALPHA) The visual format applied to a matched cell or row. | |
(ALPHA) A rule targeting one measure or attribute with one or more stacked conditions. The first matching condition (top-down) wins. | |
(ALPHA) AND condition — all nested conditions must be satisfied. | |
(ALPHA) OR condition — at least one of the nested conditions must be satisfied. | |
Cross-filtering | |
(ALPHA) Analytical dashboard consists of widgets (widgets are kpis or insights with additional settings - drilling and alerting), layout (which defines rendering and ordering of these widgets), and filter context (configured attribute and date filters). It’s also possible to setup scheduled emails for the dashboard (user will receive an email with the exported dashboard attached at the specified time interval), and optionally extended date filter config. | |
(ALPHA) Arbitrary attribute filter of the filter context. | |
(ALPHA) Email attachment - dashboard exported as pdf. | |
Attribute filter of the filter context | |
(BETA) Dependent date filter of an attribute filter of the filter context | |
(ALPHA) Extended attribute filter config | |
(BETA) Parent filter of an attribute filter of the filter context | |
Reference to a particular dashboard attribute filter This is commonly used to define filters to ignore for the particular dashboard widget | |
(ALPHA) Dashboard common properties | |
Date filter of the filter context | |
(ALPHA) Date filter presets to add to the date filter for the current dashboard | |
(ALPHA) Extended date filter config | |
(ALPHA) Extended date filter config item for date filters fully specified including date data set | |
Reference to a particular dashboard date filter This is commonly used to define filters to ignore for the particular dashboard widget | |
(ALPHA) Dashboard definition represents modified or created dashboard | |
(ALPHA) Backend-neutral parameter value carried on a dashboard tabular export. | |
(ALPHA) Single dashboard filter group configuration. Title is displayed in the filter bar. Filters are removed from the filter bar and displayed under the group. There is no way to have single filter in multiple groups or in a group and in the filter bar directly. If you want such behavior, you need to define multiple fitlers with specific local identifiers. | |
(ALPHA) Single filter in a group. It does not contain any filter configuration. It is just a reference to a dashboard filter context. Filter is referenced by its local identifier which is defined in filter context. If the filter does not exists it is ignored. | |
(ALPHA) Dashboard filter groups config. There can be multiple groups defined. Group is displayed in a filter bar beside other filters. Order is defined by the first filter in the group. Meaning the group is displayed in the place of the first filter hwo defined in filter context. If there are no filters in the group, the group is not displayed. If there are no groups defined, filters are displayed ungrouped. | |
(ALPHA) Interface that represents saved dashboard filter view created for a specific dashboard by a specific user. There should always be just one default filter view for the user and the dashboard at any given time. The consistency must be handled by backend or client. The reason why the flag cannot be on the dashboard is that each user can have a different default filter view per dashboard and also the filter views can be created by users that have only VIEW permission for the workspace and cannot modify the dashboard object. | |
(ALPHA) Interface that represents an entity provided to SPI function that creates a new dashboard filter view IDashboardFilterView entity. | |
Dashboard layout describes the data to be displayed on the dashboard, and their structure for UI rendering. Generic TWidget param is here to support type checking with custom widgets (e.g. in Dashboard component). | |
(ALPHA) Layout configuration. | |
Dashboard layout item - usually contains kpi widget, insight widget or another nested layout. Generic TWidget param is here to support type checking with custom widgets (e.g. in Dashboard component). | |
Dashboard layout section represents a group of widgets on the dashboard with a title and description. | |
Dashboard layout section header definition. | |
(ALPHA) Configuration that affects all sections of the layout. | |
Dashboard layout size definition. | |
Dashboard layout size configuration, defined by screen type. | |
Widget representing nested layout | |
(ALPHA) Match attribute filter of the filter context. | |
(ALPHA) Measure value filter of the filter context. | |
(ALPHA) Extended measure value filter config | |
Reference to a particular dashboard measure value filter This is commonly used to define filters to ignore for the particular dashboard widget | |
Dashboard metadata object | |
Object unique identity | |
(ALPHA) Dashboard-level parameter override entry. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) A link between dashboard and a plugin that it uses. Optionally contains parameters that should be passed to the plugin at load time. | |
(ALPHA) Dashboard tab definition. | |
(ALPHA) Dashboard-level timezone configuration. | |
Dataset column with name, type and boolean flag whether the column needs to be skipped while data loading or not. | |
Data column object interface. | |
Structural information about CSV header and columns. | |
Dataset describes a particular structure of dataset (CSV file). | |
Dataset object interface. | |
Object wrapping basic information (owner, date created, status) about a CSV Load. | |
DataSet metadata object | |
Object wrapping info about the user that created CSV load. Contains their login and full name. | |
(ALPHA) | |
(ALPHA) Descriptor contains details about data source permission of organization user or user group. | |
(ALPHA) Date filter configs allow to define your own date filter options, that appear in the date filter. | |
(ALPHA) Common props for date filter options | |
(ALPHA) | |
(ALPHA) Hierarchy template for date dataset | |
(BETA) Default export template setting. | |
Dimensions specify how to organize the results of an execution in a data view. | |
Dimension descriptor is the output counter-part of the dimension specification that was included in the execution definition. | |
Drill base type | |
Defines properties that are used for drillable widgets. Such widgets allow user clicking on different parts of the widget and through this interaction navigate to other insights or dashboards. | |
(ALPHA) Defines mapping between particular drill down hierarchy and attributes to ignore in the intersection during the drill down for this hierarchy. | |
Drill from attribute | |
Drill from measure | |
Drill origin base type | |
Drill to attribute url | |
Drill to attribute url target | |
Drill to custom url | |
Drill to custom url target | |
Drill to dashboard | |
Drill to insight | |
Drill to PP dashboard | |
(BETA) | |
(BETA) | |
(ALPHA) Preset option for empty date values (records with no date) | |
(ALPHA) A granularity enabled on a custom fiscal calendar (mirrors the calendar’s | |
Entitlement descriptor | |
Contains any configuration that should be part of execution | |
Execution definition contains 100% complete description of what will the execution compute and how will the resulting data look like. | |
(ALPHA) Describes a limit broken during result computation, resulting in partial data being returned. | |
(ALPHA) Object describing minimal properties of existing dashboard. | |
(ALPHA) Export definition base An object containing the core properties of an export definition | |
(ALPHA) Export definition dashboard content configuration. | |
(ALPHA) Export definition dashboard settings | |
(ALPHA) Export definition | |
(ALPHA) Export definition | |
(ALPHA) Export definition visualization content configuration. | |
(ALPHA) Export definition visualization object settings | |
(ALPHA) Configuration of the exported file | |
Export result. | |
(BETA) Export template metadata. | |
(BETA) Settings for a content slide. | |
(BETA) Settings for a cover slide. | |
(BETA) Template describing how a dashboard is rendered into slides. | |
(BETA) Export template payload used to create or update an export template. | |
(BETA) Settings for an intro slide. | |
(BETA) Running (header or footer) section of a slide. | |
(BETA) Settings for a section slide. | |
(BETA) Template describing how a single widget is rendered into slides. | |
(ALPHA) External pluggable application registry item, v1. Loaded from an external application hosted module outside the shell, i.e., external link that will replace the application window. | |
(ALPHA) Definition of the pluggable application that is just a URL link. The default UI will replace the application window with the URL link. | |
Fact metadata object | |
Setting properties are used to gate features that are in development or in various stages of rollout. Each property will be retired in a future version of the SDK once the feature has been rolled out to all users and is considered stable enough that there is no longer a need to roll it back or disable it easily. On the Panther platform, each setting is controlled by FeatureHub and is registered as a feature flag in the backend so that it can be configured for GoodData.CN (Tiger). | |
Defines properties that are used for filterable widgets. Filterable widgets allow users to specify:
| |
(ALPHA) Filter context consists of configured attribute and date filters (which could be applied to the dashboard, widget alert, or scheduled email) | |
(ALPHA) Common filter context properties | |
(ALPHA) Filter context definition represents modifier or created filter context | |
Fiscal year calendar configuration | |
(ALPHA) Represents a single choice option. | |
(ALPHA) Represents a clarifying question for an ai chat response. | |
(ALPHA) Represents a single choice control. | |
(ALPHA) Represents a custom geo collection stored at the organization level. | |
(ALPHA) Definition for creating a new geo collection (without id). | |
(ALPHA) Result of staging a file upload for geo collection import. | |
Access grantee specification with granular permissions. | |
(ALPHA) Query describing which granularities to return. | |
(ALPHA) Canonical, calendar-independent metadata for a single date granularity. | |
(ALPHA) Rules access specification with granular permissions. | |
All workspace user access grantee specification with granular permissions. | |
(ALPHA) User access specification with granular permissions. | |
User access grantee specification with granular permissions. | |
(ALPHA) User group access specification with granular permissions. | |
User group access grantee specification with granular permissions. | |
Properties contained in each groupable catalog item | |
Filter able to identify itself via local identifier | |
Inline measures are defined as MAQL measures inline string. | |
(BETA) | |
(ALPHA) Defines a single layer in a multi-layer visualization (e.g., geo charts). | |
(ALPHA) Value of a workspace parameter for a single insight execution. | |
Configuration of widget’s description | |
(ALPHA) Represents an organization IP allowlist policy returned by the backend. | |
(ALPHA) User assigned to an IP allowlist policy, enriched with display info resolved from the JSON:API | |
(ALPHA) User group assigned to an IP allowlist policy, enriched with display info resolved from the JSON:API | |
(ALPHA) Definition used to create an organization IP allowlist policy. | |
Key drive analysis | |
Common kpi properties | |
Configuration of kpi’s description | |
Kpi without comparison | |
Kpi with period over period comparison | |
Kpi with previous period comparison | |
(ALPHA) Listed dashboard - to display the dashboard in the list Only a subset of dashboard data is available, for the full definition see IDashboard | |
(ALPHA) Base endpoint interface | |
(ALPHA) OpenAI endpoint interface | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Definition of the pluggable application deployed locally with the shell application. The application is loaded from the host bundle asynchronously via lazy-loaded import. | |
(ALPHA) Local pluggable application registry item, v1. Loaded from the host bundle asynchronously. | |
(ALPHA) Pluggable application registry, v1. | |
Object defining the ILowerBoundedFilter object body. | |
Match attribute filter - literal matching filter for attribute values. | |
Object defining the IMatchAttributeFilter object body. | |
(BETA) Shared metadata object properties. This type represents metadata object with unique id assigned to it. Typically metadata object, that is already persisted on the backend. | |
(BETA) | |
(BETA) Metadata object definition. This type represents metadata object without unique id assigned to it. Typically metadata object, that is not yet persisted on the backend. | |
(BETA) | |
All types of measures have a set of common properties; those are defined here. | |
Object defining the IMeasure object structure. | |
Simple measures are defined from existing MAQL measures or logical data model facts. | |
Object defining the IMeasureDefinition object structure. | |
(ALPHA) (EXPERIMENTAL) Override for a catalog metric definition. | |
Describes measure included in a dimension. | |
Measure descriptor object. | |
Descriptor of the measure and its contents. | |
Describes measure group and its contents. | |
Locator that specifies a concrete measure to sort by. | |
Object defining the IMeasureLocatorItem object structure. | |
Sort item which specifies that the result should be sorted by value of a measure. | |
Measure sort target. | |
Subset of IMeasure interface which defines properties that MAY be used to provide human readable description of the measure. | |
Object defining the IMeasureTitle object body. | |
Options for creating a measure value filter with ALL operator. | |
Object defining the IMeasureValueFilter object body. | |
Options for creating a measure value filter with comparison condition. | |
Options for creating a measure value filter with multiple conditions. | |
Options for creating a measure value filter with range condition. | |
Memory item definition. | |
Memory item metadata object | |
(ALPHA) Describes metric format override configuration. | |
Negative attribute filter essentially adds an | |
Object defining the INegativeAttributeFilter object body. | |
(ALPHA) | |
Notification with details about the automation or test that triggered it. | |
(ALPHA) | |
(BETA) Lightweight identifier object for notification channel. | |
(BETA) Shared base interface for all notification channel metadata objects. | |
(BETA) | |
Number parameter constraints. | |
Number parameter definition. | |
(ALPHA) Current access state for a single object: a flat list of grants. Grants reuse the shared AccessGranteeDetail union. | |
(ALPHA) Configuration of integration of OpenAI. | |
(ALPHA) | |
Condition for ALL operator. | |
Condition for comparison operator. | |
Condition for range operator. | |
(ALPHA) | |
Organization descriptor contains details about the organization that services analytical workspaces. | |
Organization descriptor properties to update. Optional properties can be set to null to delete the value. | |
(ALPHA) | |
(ALPHA) User with organization related information. | |
(ALPHA) User group with organization related information. | |
Allowed value of a string parameter. When a definition’s | |
Parameter metadata object. | |
Parameter metadata object definition. | |
Setting properties are used to customize platform behavior for end users. These are permanent setting options that are intended to remain, unlike feature-flag-based settings. On the Panther/Tiger platform, each setting is backed by a metadata object with a unique setting type registered in the backend. | |
(ALPHA) Pluggable application meta-information, v1. | |
Defines Period-Over-Period measure (or Time-over-Time). | |
Object defining the IPoPMeasureDefinition object body. | |
Positive attribute filter essentially adds an | |
Object defining the IPositiveAttributeFilter object body. | |
Contains any configuration that should be done with the data after they are obtained from the server and before they are passed to the user. | |
This is used to specify previous period. | |
Simplified Previous Period Data DataSet specification | |
This is a derived measure that calculates value of a measure referenced by measureIdentifier for previous period. | |
Object defining the IPreviousPeriodMeasureDefinition object body. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Both ends are inclusive. | |
(ALPHA) Text generated by AI at document-build time. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Paint of the box itself. Never affects the geometry of the box or its children — geometry always comes from layout weights. | |
(ALPHA) Box keys. They apply to the node they are set on and never inherit. | |
(ALPHA) | |
(ALPHA) Solid color painted behind a section’s or page’s content. | |
(ALPHA) | |
(ALPHA) Row or column of layout nodes. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Fields shared by document definitions and persisted documents. | |
(ALPHA) Keys shared by both shapes of document content. | |
(ALPHA) | |
(ALPHA) Versioned content shared verbatim by document templates and documents. | |
(ALPHA) | |
(ALPHA) Payload for creating or updating a document. | |
(ALPHA) Payload for creating or updating a document. | |
(ALPHA) Document content stored as a flat list of pages. | |
(ALPHA) Page instance embedded in template/document content: a deep clone of a page body plus its own identity. | |
(ALPHA) Page inside a document. | |
(ALPHA) Document content stored as sections of pages. | |
(ALPHA) Style of the area behind the pages. Exports ignore it. | |
(ALPHA) Payload for creating or updating a document template. | |
(ALPHA) Payload for creating or updating a document template. | |
(ALPHA) Document template metadata object. | |
(ALPHA) Document template metadata object. | |
(ALPHA) Document metadata object. | |
(ALPHA) Document metadata object. | |
(ALPHA) Fields shared by the definitions of all Publisher entities. | |
(ALPHA) Fields shared by all persisted Publisher entities. | |
(ALPHA) Slot rendering a heading. | |
(ALPHA) Styling of a heading slot. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Image painted behind a section’s or page’s content. | |
(ALPHA) Slot rendering an image. | |
(ALPHA) Where the drawn image sits when it does not fill its box, and which part of it is kept when it is cropped to fill one. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Text keys that a page or container passes down to the content inside, unless a widget sets its own. | |
(ALPHA) Fields common to all layout nodes. | |
(ALPHA) A container splitting its area into children laid out along a direction. | |
(ALPHA) A leaf assigning its area to a slot. The slot fills the area completely. | |
(ALPHA) | |
(ALPHA) Body of a document page: geometry (flex split tree) plus the slots it places. | |
(ALPHA) Content of one page, as a page template stores it. | |
(ALPHA) Validation issue found in a page body. | |
(ALPHA) | |
(ALPHA) Stored content of the reportPage entity. | |
(ALPHA) Payload for creating or updating a page template. | |
(ALPHA) Payload for creating or updating a page template. | |
(ALPHA) Reusable page template metadata object. | |
(ALPHA) Page template metadata object. | |
(ALPHA) Slot rendering prose, written as markdown. | |
(ALPHA) Styling of a paragraph slot. | |
(ALPHA) Both ends are inclusive. | |
(ALPHA) Named group of pages. | |
(ALPHA) | |
(ALPHA) Structural base of every document slot. | |
(ALPHA) Metadata of a slot that is intentionally left unfilled in a page template or document template. | |
(ALPHA) Author-written text. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Styling of a text slot: the paint of its box, plus the ink and placement of the text it owns. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Page title: the PowerPoint slide title and the page name for screen readers. | |
(ALPHA) | |
(ALPHA) A custom variable declared by document content and given a value by a document. | |
(ALPHA) Overrides of the saved visualization’s display settings. | |
(ALPHA) | |
(ALPHA) Slot rendering an insight, with its own filter context. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
Object defining the IRangeCondition object body. | |
Object defining the IRankingFilter object body. | |
Object defining the IRelativeDateFilter object body. | |
Object defining the IRelativeDateFilter object body. | |
Object defining the IRelativeDateFilter object body. | |
(ALPHA) Customized options for the global relative date filter | |
(ALPHA) Custom relative date filter preset | |
(ALPHA) Generic type to express relative date filter preset of a particular granularity | |
Represents values of a relative filter. | |
(ALPHA) Definition of the remote pluggable application. The application is loaded via Module Federation. | |
(ALPHA) Remote pluggable application registry item, v1. Loaded via Module Federation. | |
(ALPHA) Pluggable application remote registry, v1. | |
Attribute header specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong. | |
Attribute header item specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong. | |
Measure header specifies name of the measure to which the calculated values in the particular data view slice belong. | |
Measure header specifies name of the measure to which the calculated values in the particular data view slice belong. | |
Total header specifies name and type of total to which the calculated values in particular data view slice belong. | |
Total header specifies name and type of total to which the calculated values in particular data view slice belong. Also can contain measure index which can be used to lookup the measure which belongs to this total. | |
Represents an execution result warning. (e.g. when execution was executed successfully, but backend didn’t take something into the account) | |
Color defined used RGB values. | |
RGB Color value specification. | |
(ALPHA) A scheduled email is used to notify a user with an exported dashboard according to a specified time interval | |
(ALPHA) A scheduled email common properties | |
(ALPHA) A scheduled email is used to notify a user with an exported dashboard according to a specified time interval | |
/** Notification with details about the schedule that triggered it. | |
Details of the schedule notification. | |
(ALPHA) Conditional-formatting rules authored once on a semantic-layer catalog object (label, metric, fact, or date dataset) and carried on the matching execution result header ( | |
(BETA) Certification info surfaced on a semantic search result item. | |
(BETA) Represents an error encountered during a semantic search operation. | |
(BETA) Reference between two metadata objects. | |
(BETA) Semantic search result payload. | |
(BETA) A single search result returned by semantic search. | |
Settings for regional number formatting | |
Settings are obtained from the backend and are effectively a collection of feature flags or settings with concrete string or numeric value. | |
(BETA) | |
Sorting direction part of sort. | |
Source insight attribute filter reference. | |
Source insight date filter reference. | |
Source insight measure value filter reference. | |
Source insight ranking filter reference. | |
String parameter constraints. | |
String parameter definition. | |
(ALPHA) Temporary filter context serves to override original dashboard filter context during the dashboard export | |
Notification with details about the test that triggered it. | |
Notification with details about the automation or test that triggered it. | |
(BETA) Theme used to customize selected parts of the UI | |
(BETA) Analytical designer specific properties. | |
(BETA) Analytical designer title specific properties. | |
(ALPHA) Externally hosted image the theme offers to documents. | |
(ALPHA) Image assets linked by URL, grouped by what they are used for. | |
(BETA) Axis customization | |
(BETA) Button customizable UI properties | |
(BETA) Charts customization | |
(BETA) Tooltip customization | |
(BETA) Variants of the palette color | |
(ALPHA) Reference to an existing color palette object, in the same shape the active color palette setting uses. | |
(BETA) Used to color various elements across many components by replacing the default complementary palette of gray color shades | |
(BETA) KPI dashboards specific properties | |
(BETA) Dashboard content customizable properties. | |
(BETA) Dashboard content KPI customizable properties. | |
(BETA) Dashboard content widget customizable properties. | |
(BETA) Edit panel specific properties. | |
(BETA) Dashboard filterBar customizable properties. | |
(BETA) Filter bar button specific properties | |
(BETA) Navigation customizable properties. | |
(BETA) Navigation items (dashboards) specific properties. | |
(BETA) Dashboard navigation title specific properties. | |
(BETA) Dashboard section customizable properties. | |
(BETA) Dashboard section description properties. | |
(BETA) Dashboard section title properties. | |
(BETA) Dashboard title specific properties. | |
(BETA) Data label customization | |
(ALPHA) Theme definition represents modified or created theme | |
(ALPHA) How documents with content version 2 look. | |
(ALPHA) A color offered to documents. Content stores its id, never its position in the list. | |
(ALPHA) Colors offered to documents, one list per kind of paint. | |
(ALPHA) Corner radius steps; | |
(ALPHA) One hosted font file registered as a font face for documents. | |
(ALPHA) Heading text styles. | |
(ALPHA) The look of marked text: strong, emphasis, highlight or link. | |
(ALPHA) Page defaults of documents. | |
(ALPHA) A named shadow, referenced from content as | |
(ALPHA) Spacing scales of documents. | |
(ALPHA) The named steps of a document spacing scale. | |
(ALPHA) Body text styles. | |
(ALPHA) Values a group of text styles shares unless a level sets its own. | |
(ALPHA) One named text style. | |
(ALPHA) The named text styles of documents. | |
(ALPHA) Fonts of documents. | |
(ALPHA) Application header (top bar) customizable properties. | |
(BETA) Definition of images used in the UI | |
(BETA) Kpi values customization | |
(BETA) Kpi value specific properties. | |
(BETA) Theme properties for different message variants | |
(BETA) Theme properties for a message variant | |
(ALPHA) Theme metadata object | |
(BETA) Modal customizable properties. | |
(BETA) Properties of the title of the modal. | |
(BETA) Customizable palette of major colors Inspired by Material UI palette: https://material-ui.com/customization/palette/ | |
(ALPHA) Publisher-specific theme properties. | |
(ALPHA) Colors offered to document authors as swatches. Each list is exposed as indexed CSS variables. | |
(ALPHA) One hosted font file registered as a font face for rendered documents. | |
(ALPHA) Heading levels. Each level takes what it does not state from here, then from IThemePublisherTextStyle. | |
(ALPHA) Document page properties. | |
(ALPHA) Paragraph levels. Each level takes what it does not state from here, then from IThemePublisherTextStyle. | |
(ALPHA) Typography of one text level. | |
(ALPHA) Text of rendered documents. | |
(ALPHA) Typography of rendered documents. | |
(BETA) Table customization | |
(BETA) Theme properties for different toast message variants | |
(BETA) Theme properties for a toast message variant | |
(ALPHA) Toolbar customizable UI properties | |
(BETA) Tooltip customizable UI properties | |
(BETA) Definition of both normal and bold font URIs | |
(BETA) Title of the widget | |
Describes type and granularity for calculation of Totals. | |
Describes total included in a dimension. | |
Describes total included in a dimension. | |
Locator that specifies a concrete total element for which the measure values are sliced. | |
Locator that specifies a concrete attribute element for which the total is applicable | |
(ALPHA) A referenced object that could not be returned. | |
Object defining the IUpperBoundedFilter object body. | |
Represents platform user. | |
(ALPHA) User having access to the object. | |
User access grantee specification. | |
(ALPHA) User Data Filter assigned to a specific user. | |
(ALPHA) Common fields shared by all User Data Filter subtypes. | |
(ALPHA) Definition for creating or updating a User Data Filter assigned to a specific user. | |
(ALPHA) Common fields shared by all User Data Filter definition subtypes. | |
(ALPHA) Represents platform user group. | |
(ALPHA) User group having access to the object. | |
User group access grantee specification. | |
(ALPHA) User Data Filter assigned to a user group. | |
(ALPHA) Definition for creating or updating a User Data Filter assigned to a user group. | |
Settings for a particular user. | |
Settings for a particular combination of user and workspace. | |
Variable metadata object | |
Visualization class is essentially a descriptor for particular type of visualization - say bar chart or table. | |
Object defining the IVisualizationClass object body. | |
Automation information. | |
(BETA) | |
Data from the webhook message. | |
Data from the webhook message. | |
(BETA) Metadata object for webhook notification channel. | |
Configuration of WhiteLabeling. | |
(ALPHA) See IWidgetAlertDefinition | |
(ALPHA) Common widget alert properties | |
(ALPHA) With widget alert, user can be notified to his email according to provided rules (e.g. when some measure exceeds/drops below the set value) | |
(ALPHA) Email attachment - widget exported as csv or/and xlsx. | |
Defines properties that are used to store widget’s descriptive metadata. | |
(ALPHA) Workspace access specification with granular permissions. | |
(ALPHA) Entity that represents Workspace Data Filter | |
(ALPHA) Entity that contains data necessary to create a new Workspace Data Filter | |
(ALPHA) Entity that represents Workspace Data Filter setting | |
(ALPHA) Descriptor contains details about workspace permission of organization user or user group. | |
Settings for a particular workspace. | |
Represents platform user in context of the workspace. | |
(ALPHA) User Group |
Variables
Variable | Description |
|---|---|
Predicate that returns true for any attribute. | |
This predicate evaluates true for any bucket. | |
Implementation of measure predicate which always returns true. | |
(ALPHA) Possible data source permissions that can be assigned. | |
(ALPHA) Possible workspace permissions that can be assigned either directly or hierarchically. | |
(ALPHA) Value of IDashboardTimezoneConfig.timezoneId representing that the effective timezone should be detected from the viewer’s browser at load time. It is not a valid IANA identifier, so it cannot collide with a real timezone. This sentinel is only allowed in the dashboard content (DashboardTimezoneId). Values sent to executions or exports must always be concrete IANA IDs — resolve the sentinel first via resolveTimezoneId(). | |
(ALPHA) Current version of BuiltInPublisherSlotTypesV1. | |
(ALPHA) List of built-in document slot type names. | |
(ALPHA) List of built-in widget types. These type names are reserved and must not be used by custom widgets. | |
(ALPHA) Built-in CSV delimiter presets keyed by preset id. | |
(ALPHA) How a subject gains access to a data source. | |
Defines shortcuts for commonly used date dataset attribute granularities. | |
(ALPHA) Standard-calendar granularities that an absolute (static) date filter can be configured with. | |
(ALPHA) Identifier of the default CSV delimiter preset. | |
(ALPHA) The default CSV delimiter character (comma). | |
Default value for ILocale. | |
(ALPHA) Current version of DefaultPublisherHeadingTypeV1. | |
(ALPHA) Size a heading slot that states none is rendered at. | |
(ALPHA) Current version of DefaultPublisherPageFormatV1. | |
(ALPHA) Format assumed by a page that declares none, which keeps pages authored before formats existed on the shape they were designed for. | |
(ALPHA) | |
(ALPHA) Current version of DefaultPublisherPageTemplateCoverV1. | |
(ALPHA) Default cover page: document title and subtitle. | |
(ALPHA) Current version of DefaultPublisherPageTemplatePortraitCoverV1. | |
(ALPHA) Default portrait cover page: document title and subtitle. | |
(ALPHA) Current version of DefaultPublisherPageTemplatePortraitSectionV1. | |
(ALPHA) Default portrait section divider page. | |
(ALPHA) Current version of DefaultPublisherPageTemplatePortraitSummaryV1. | |
(ALPHA) Default portrait page carrying a full-page narrative, with no visualization. | |
(ALPHA) Current version of DefaultPublisherPageTemplatesV1. | |
(ALPHA) Current version of DefaultPublisherPageTemplateSectionV1. | |
(ALPHA) Default section divider page. | |
(ALPHA) All default page templates served by the SPI. They are read-only: they cannot be edited or deleted, and they are never persisted on the backend. | |
(ALPHA) Current version of DefaultPublisherPageTemplateViz6TextLeftV1. | |
(ALPHA) Default content page with six visualizations and a text column on the left. | |
(ALPHA) Current version of DefaultPublisherParagraphTypeV1. | |
(ALPHA) Size a paragraph slot that states none is rendered at. | |
(ALPHA) Known cell-oriented execution result limit types. | |
(ALPHA) Known column-oriented execution result limit types. | |
(ALPHA) Known execution result limit types grouped by semantic kind. | |
(ALPHA) Known row-oriented execution result limit types. | |
Geo chart layer types. | |
Geo chart root visualization types. | |
(ALPHA) Current version of getPublisherTextPlaceholdersV1(). | |
(ALPHA) Canonical registry of every DateAttributeGranularity. | |
(ALPHA) Current version of isPublisherColorBackgroundV1(). | |
(ALPHA) Current version of isPublisherDocumentV1(). | |
(ALPHA) Current version of isPublisherDocumentDefinitionV1(). | |
(ALPHA) Current version of isPublisherDocumentTemplateV1(). | |
(ALPHA) Current version of isPublisherDocumentTemplateDefinitionV1(). | |
(ALPHA) Current version of isPublisherHeadingSlotV1(). | |
(ALPHA) Current version of isPublisherHeadingTypeV1(). | |
(ALPHA) Current version of isPublisherImageBackgroundV1(). | |
(ALPHA) Current version of isPublisherImageSlotV1(). | |
(ALPHA) Current version of isPublisherLayoutSectionV1(). | |
(ALPHA) Current version of isPublisherLayoutSlotRefV1(). | |
(ALPHA) Current version of isPublisherPageFormatV1(). | |
(ALPHA) Current version of isPublisherPageTemplateV1(). | |
(ALPHA) Current version of isPublisherPageTemplateDefinitionV1(). | |
(ALPHA) Current version of isPublisherParagraphSlotV1(). | |
(ALPHA) Current version of isPublisherParagraphTypeV1(). | |
(ALPHA) Current version of isPublisherSlotV1(). | |
(ALPHA) Current version of isPublisherTextSlotV1(). | |
(ALPHA) Current version of isPublisherVisualizationSlotV1(). | |
(ALPHA) Maximum number of instructions a single agent can carry. | |
Measure Group is a pseudo-identifier which can be used in an execution dimension and indicates that this dimension MUST contain all the measures. | |
(ALPHA) Current version of newAdHocPublisherDocumentDefinitionV1(). | |
(ALPHA) Current version of newPublisherDocumentContentV1(). | |
(ALPHA) Current version of newPublisherDocumentDefinitionFromTemplateV1(). | |
(ALPHA) Current version of newPublisherDocumentPageFromTemplateV1(). | |
(ALPHA) Current version of newPublisherDocumentTemplateDefinitionV1(). | |
(ALPHA) Current version of newPublisherPageTemplateDefinitionV1(). | |
(ALPHA) | |
(ALPHA) Current version of PublisherBuiltInVariablesV1. | |
(ALPHA) All built-in document variable names. | |
(ALPHA) Current version of publisherDocumentPageV1(). | |
(ALPHA) Current version of PublisherHeadingTypesV1. | |
(ALPHA) All heading sizes, largest first. | |
(ALPHA) Current version of PublisherPageFormatAspectRatiosV1. | |
(ALPHA) Width divided by height for each page format: 16:9 for a widescreen page, ISO A4 (210 x 297 mm) and US Letter (8.5 x 11 in) upright. | |
(ALPHA) Current version of PublisherPageFormatsV1. | |
(ALPHA) List of built-in page format names. | |
(ALPHA) | |
(ALPHA) Current version of PublisherParagraphTypesV1. | |
(ALPHA) All paragraph sizes, largest first. | |
(ALPHA) Current version of publisherTextPlaceholderV1(). | |
(ALPHA) Current version of publisherTextSlotTypeV1(). | |
(ALPHA) Current version of publisherTextSlotTypesV1(). | |
(ALPHA) | |
(ALPHA) Current version of PublisherTextTypesV1. | |
(ALPHA) All sizes a text slot can be rendered at, headings first. | |
(ALPHA) All document text variable names. | |
(ALPHA) | |
(ALPHA) Current version of resolvePublisherTextPlaceholdersV1(). | |
(ALPHA) Current version of validatePublisherPageBodyV1(). | |
(ALPHA) How a subject gains access to a workspace. |
Type Aliases
Type Alias | Description |
|---|---|
(ALPHA) Entity having access to the object. | |
Type of granted granular access. | |
(ALPHA) Available skill types for an AI agent. | |
(ALPHA) Determines when an agent instruction is applied to a request. | |
(ALPHA) Skills mode for an AI agent. | |
Alert description status. | |
Visible filters applied. | |
Visible parameters applied. | |
Special granularity used to indicate there should be no date filtering for the given dimension. | |
Reserved type names used for dashboard’s built-in analytical widgets. | |
(ALPHA) Defines in which scope the application should be registered. The default UI uses this information to determine if the application is visible in the organization or workspace portal. | |
Input to the ArithmeticMeasureBuilder. | |
Simple math operators for arithmetic measure construction. | |
(ALPHA) Data source permission values. | |
(ALPHA) Workspace permission values. | |
Input to the AttributeBuilder. | |
Attribute display form type | |
Describes exact location of attribute in a bucket. | |
Function that will be called to perform modifications of an attribute before it is fully constructed. | |
Defines function signature for measure predicates. | |
(ALPHA) Evaluation mode for automation. - SHARED: All recipients receive the same evaluation result - PER_RECIPIENT: Each recipient receives personalized evaluation results | |
Automation notification type. | |
Describes the type of the function used to modify the bucket items. | |
Describes the type of the function used to reduce the bucket items. | |
Signature for bucket predicates; predicates are used by different functions to find/filter buckets according to some criteria. | |
(ALPHA) Calendar a granularity belongs to. | |
(ALPHA) Which calendar the caller is resolving granularities for. | |
Calendar type | |
Type representing catalog item - attribute, measure, fact, dateDataset or computedAttribute | |
Type representing catalog item type - attribute, measure, fact, dateDataset, attributeHierarchy or computedAttribute | |
Direction of the comparator. | |
Data type of the computed attribute values. | |
Specific type of the computed attribute values, the counterpart of a label value type. | |
(ALPHA) Logical condition for evaluating requirement properties. Supports composable AND/OR logic for determining whether an application should be accessible. Conditions can be nested arbitrarily to express complex boolean expressions. There are three forms:
| |
(ALPHA) Emptiness operators — target-agnostic: an empty cell (null measure value, valueless attribute element) is matched only by these, on any target kind. | |
(ALPHA) Every operator a stored condition may carry. One shared, shape-grouped vocabulary: numeric and range operators reuse the SDK measure-value-filter enums ( | |
(ALPHA) Identifies the measure or attribute a conditional-formatting rule targets. Layout-neutral on purpose: the same target applies whether the item renders as a column or — when transposed — as a row, so the rule survives a transpose without re-pointing. | |
(ALPHA) Substring operators specific to conditional formatting. No existing SDK enum covers text matching (attribute filters are element-based IN/NOT_IN), so these are CF-specific. | |
(ALPHA) The operand a condition compares against. Discriminated so range / no-operand / date / (future column-reference) shapes stay valid by construction. Date values target date attributes and express a period; a single date is a period whose bounds coincide. “Is on” (EQUAL_TO) means the cell’s period lies within the value period; “Is after” (GREATER_THAN) means after the period ends; “Is before” (LESS_THAN) before it starts. | |
(ALPHA) Identifier of a CSV delimiter preset, “custom” when the user provides their own character, or “inherit” when no delimiter should be sent and the backend-resolved default should apply. | |
(ALPHA) Identifier of a built-in CSV delimiter preset. | |
(ALPHA) Validation error codes returned by getCsvDelimiterValidationError().
| |
(ALPHA) Dashboard attachment types. | |
(ALPHA) Attribute filter configuration mode | |
(ALPHA) Union of all dashboard attribute-based filter types, including element selection filters and text mode filters (arbitrary, match). | |
(BETA) Attribute filter selection mode value | |
(ALPHA) Attribute filter available mode — controls which filter presentation modes (list-based, text-based, or both) are available to the user in Dashboard View mode. | |
(ALPHA) Date filter configuration mode | |
Values of Dashboard Filters Apply Mode setting. Used for organization and workspace. INDIVIDUAL mean that each filter has its own apply button. ALL_AT_ONCE mean that there is a single apply button for all dashboard filters. | |
(ALPHA) Dashboard parameter mode — mirrors filter mode triple. | |
(ALPHA) Union of text mode attribute filter types (arbitrary and match). | |
(ALPHA) Timezone value as stored in the dashboard content: an IANA timezone ID (e.g. “Europe/Prague”), or the BROWSER_DETECTED sentinel to be resolved at load time. Never pass this type to executions or exports unresolved — use resolveTimezoneId(). | |
Represents type of LDM field created from the Dataset column. | |
Represents the current status of CSV source. | |
(ALPHA) Data source access source values: directly assigned or inherited from a user group. | |
(ALPHA) | |
Single calculated data value. | |
All possible date dataset attribute granularities. | |
(BETA) Date filter type - absolute | |
(BETA) Supported date filter granularity for the relative date filter | |
(ALPHA) Type that identifies the absolute date filter form | |
(ALPHA) Type that identifies the absolute date filter preset | |
(ALPHA) Type that identifies the the all time date filter | |
(ALPHA) Type that identifies the empty date values date filter option | |
(ALPHA) Type that identifies the relative date filter form | |
(ALPHA) Type that identifies the relative date filter preset | |
(ALPHA) Type that identifies the date filter option | |
(BETA) Date filter type - relative | |
(BETA) Date filter type - relative or absolute | |
(BETA) Date string - ISO-8601 calendar date string, eg.: ‘2018-12-30’ | |
Function transforming a list of buckets (with attributes and measures) into execution dimension descriptors. | |
Defines union of items that can be placed into a dimension. | |
Widget drill definition | |
Drill origin | |
Drill origin type | |
Drill transition | |
Drill type | |
(BETA) | |
(BETA) | |
Determines how date filters should treat empty values. | |
(ALPHA) All known cell-oriented execution result limit types. | |
(ALPHA) All known column-oriented execution result limit types. | |
(ALPHA) Semantic kind of a known execution result limit type. | |
(ALPHA) All known execution result limit types. | |
(ALPHA) All known row-oriented execution result limit types. | |
(BETA) Export type a slide template applies to. | |
(BETA) Scope of an export template referenced by the default export template setting. | |
(ALPHA) External pluggable application registry item. Loaded from an external application hosted module outside the shell, i.e., external link that will replace the application window. | |
(ALPHA) Supported filter context items | |
(BETA) Forecast single data value | |
User feedback for the chat interaction. | |
(BETA) Type of the object. | |
(ALPHA) Kind of geo collection. | |
Geo chart layer type. | |
Geo chart root visualization type. | |
(ALPHA) Structural family of a date granularity. | |
Type representing groupable catalog item - attribute, measure or fact | |
Access grantee specification. | |
(ALPHA) Patch definition for an AI agent. All fields except id are optional. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
Attribute elements are used in positive and negative attribute filters. They can be specified either using URI (primary key) or using textual values of the attribute elements. | |
Attribute filters limit results of execution to data pertaining to attributes that are or are not specified by the filters. | |
Attribute filter config | |
Definition of UI specific attribute filters configs. These influence how the filters are displayed in the UI not the execution. | |
Attribute filter with element selection - either positive (IN) or negative (NOT IN). | |
Type representing bucket items - which can be either measure or an attribute. | |
Object that can provide information about the users that created or modified it and when those actions occurred. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Grantee that is available as target for granting of a permission to shared object. | |
A color. It can be specified by referencing an item from from user-defined color palette or by RGB Value. | |
User-defined color palette. Colors from the palette can be used as input to charts and naturally influence the coloring strategy for the chart. | |
Function that can be used to sort collections. The semantics are the same as the first argument to Array#sort function. | |
Computed attribute metadata object. | |
Computed attribute metadata object definition (not yet persisted). | |
(BETA) | |
Execution-filter form of a dashboard filter: what a FilterContextItem becomes once it is resolved against the object it filters. | |
Reference to a particular dashboard filter This is commonly used to define filters to ignore for the particular dashboard widget | |
(ALPHA) Represents the possible layout container directions in a dashboard structure. The direction determines how child elements are arranged within a container. - “row”: Child elements are arranged horizontally. - “column”: Child elements are arranged vertically. | |
(ALPHA) Dashboard permissions. | |
Default dashboard widgets - kpi widget, insight widget, or nested layout. | |
(BETA) Attribute metadata object that can appear in IDataSetMetadataObject.attributes. | |
Date filters limit the range of results to data within relative or absolute date range. | |
(BETA) | |
Type for all identifiers. | |
Model object reference using object’s unique identifier. NOTE: this is preferred way to reference model objects. | |
Headers describing contents of a dimension. | |
(ALPHA) | |
(ALPHA) Drill target | |
Entitlement name | |
(ALPHA) Export definition dashboard request payload | |
(ALPHA) Export definition request payload | |
(ALPHA) Export definition visualization object request payload | |
Export result status. | |
All possible filters. | |
(ALPHA) GeoJSON feature result. | |
Access grantee with granular permission. | |
(BETA) Metadata object definition for SMTP notification channel. | |
Represents an Insight. Insight is typically created using Analytical Designer and can be embedded using UI SDK. | |
Insight definition specifies what and how should be visualized by an insight. | |
Insight definition specifies what and how should be visualized by an insight with optional identity. | |
Identity of an Insight. Insight is typically created using Analytical Designer and can be embedded using UI SDK. | |
Kpi | |
Kpi comparison direction | |
Kpi comparison type | |
Kpi with comparison | |
Language codes that can be used with GoodData. | |
Locators are used to identify slice of measure values to sort by. | |
(BETA) Custom image URI which is used | |
Available measure definitions; this is union of simple measure, arithmetic measure, PoP measure and previous period measure. | |
All possible filters that can be specified for a simple measure. | |
Measure metadata object | |
Measure metadata object definition | |
Options for creating a measure value filter. | |
Input to the InlineMeasureBuilder. | |
Notification. | |
(BETA) | |
(BETA) | |
Contains breakdown of what display forms are used in an insight. | |
Insight widget drill definition | |
Represents a filter specification variant where either the actual filter or a ’null’ filter is provided. Null filters will be ignored during processing. | |
Parameter definition. | |
(ALPHA) Dictionary of organization permissions supported by the pluggable application manifest. | |
(ALPHA) Dictionary of workspace permissions supported by the pluggable application manifest. | |
(ALPHA) Current version of IPublisherAiTextSourceV1. | |
(ALPHA) Current version of IPublisherAttributeFilterConfigV1. | |
(ALPHA) Configuration of a document’s content-level attribute filter: the part of a dashboard attribute filter’s configuration that documents support. | |
(ALPHA) Current version of IPublisherBoxStyleV1. | |
(ALPHA) Current version of IPublisherColorBackgroundV1. | |
(ALPHA) Current version of IPublisherDocumentV1. | |
(ALPHA) Current version of IPublisherDocumentBaseV1. | |
(ALPHA) Current version of IPublisherDocumentContentV1. | |
(ALPHA) Current version of IPublisherDocumentDefinitionV1. | |
(ALPHA) Current version of IPublisherDocumentPageV1. | |
(ALPHA) Current version of IPublisherDocumentTemplateV1. | |
(ALPHA) Current version of IPublisherDocumentTemplateDefinitionV1. | |
(ALPHA) Current version of IPublisherHeadingSlotV1. | |
(ALPHA) Current version of IPublisherHeadingStyleV1. | |
(ALPHA) Current version of IPublisherImageBackgroundV1. | |
(ALPHA) Current version of IPublisherImageSlotV1. | |
(ALPHA) Current version of IPublisherImageStyleV1. | |
(ALPHA) Current version of IPublisherLayoutNodeBaseV1. | |
(ALPHA) Current version of IPublisherLayoutSectionV1. | |
(ALPHA) Current version of IPublisherLayoutSlotRefV1. | |
(ALPHA) Current version of IPublisherPageBodyV1. | |
(ALPHA) Current version of IPublisherPageBodyValidationIssueV1. | |
(ALPHA) Current version of IPublisherPageTemplateV1. | |
(ALPHA) Current version of IPublisherPageTemplateContentV1. | |
(ALPHA) Current version of IPublisherPageTemplateDefinitionV1. | |
(ALPHA) Current version of IPublisherParagraphSlotV1. | |
(ALPHA) Current version of IPublisherParagraphStyleV1. | |
(ALPHA) Current version of IPublisherSlotBaseV1. | |
(ALPHA) Current version of IPublisherSlotPlaceholderV1. | |
(ALPHA) Current version of IPublisherStaticTextSourceV1. | |
(ALPHA) Current version of IPublisherTextSlotV1. | |
(ALPHA) Slot rendering text of either kind. | |
(ALPHA) Current version of IPublisherTextStyleV1. | |
(ALPHA) Current version of IPublisherVariableDefinitionV1. | |
(ALPHA) Current version of IPublisherVisualizationSlotV1. | |
Filters results to a relative date range. | |
Result headers provide metadata about data included in the data view. | |
(BETA) Configuration of the SMTP, where the notifications are to be sent. Custom SMTP - custom SMTP server. Default SMTP - default SMTP server (users in organization). | |
(BETA) Metadata object definition for SMTP notification channel. | |
Sort items can be used to specify how the result of an execution should be sorted. | |
Result of search of item among list of dimensions. | |
(BETA) Definition of font URI and unicode range | |
(ALPHA) Workspace access for group with granular permissions. | |
(ALPHA) Workspace access for user with granular permissions. | |
Data from the webhook message. | |
(BETA) Metadata object definition for webhook notification channel. | |
See IWidget] | |
Dictionary of workspace permissions | |
Kpi widget drill definition | |
(ALPHA) Availability of IListedDashboard. Either full (the listed dashboard is also available as a fully accessible metadata object) or only via link (full metadata object is not accessible, only the listed dashboard record). | |
(ALPHA) Patched OpenAI endpoint interface. All fields except the | |
(ALPHA) Results of the llm models test | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Results of the list models call | |
(ALPHA) | |
(ALPHA) Results of the llm provider test | |
Model object reference using object’s local identifier. | |
(ALPHA) Localized titles of pluggable application. | |
(ALPHA) Local pluggable application registry item. Loaded from the host bundle asynchronously. | |
(ALPHA) Pluggable application registry | |
Match filter operators for literal matching. | |
Simple measures created from facts can use these types of aggregations. | |
Measure without the definition. | |
Describes exact location of measure in a bucket. | |
Function that will be called to perform modifications of measure before it is fully constructed. | |
Specification of measure either by value or by local id reference. | |
Defines function signature for measure predicates. | |
Memory item strategy. | |
Type that represents any metadata object | |
Metric type categorizes metric semantics (e.g., currency). | |
(BETA) Allowed recipients of notifications from this channel. Creator - only the creator of the report. Internal - all users within the organization. | |
(BETA) Visibility of the dashboard link in the email notification. Hidden - the link is not visible Visible - the link is visible for all InternalOnly - the link is visible only for internal users | |
(BETA) Type of the destination of the notification channel, where the notifications are to be sent. | |
Type of the notification. | |
(ALPHA) Catalog object kinds that support per-object access management. | |
Metadata object types | |
(ALPHA) Who can view a newly created object. RESTRICTED means only its creator. WORKSPACE means also all workspace users, with view access. | |
Model object reference. | |
Model object reference with support of referencing objects living in the same scope using their local identifier. | |
Condition for measure value filter. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Provenance of a granted permission — granted directly to the grantee, or inherited from a group or rule. | |
Indicates current platform edition. | |
(ALPHA) Pluggable application meta-information. | |
(ALPHA) Organization permission keys supported by the pluggable application manifest. These map directly to the Tiger backend organization permission levels. | |
(ALPHA) Pluggable application registry item | |
(ALPHA) Workspace permission keys supported by the pluggable application manifest. These map directly to the Tiger backend workspace permission levels, replacing the legacy fine-grained Bear-era permissions with their real Tiger equivalents. | |
Input to the PoPMeasureBuilder. | |
Import to the PreviousPeriodMeasureBuilder. | |
(ALPHA) Current version of PublisherBackgroundV1. | |
(ALPHA) What a section or page paints behind its content. | |
(ALPHA) | |
(ALPHA) Current version of PublisherBuiltInVariableV1. | |
(ALPHA) Variables resolved by the rendering runtime; they are never declared or stored. | |
(ALPHA) Theme color reference or literal color. | |
(ALPHA) Current version of PublisherContentAlignmentV1. | |
(ALPHA) Where content sits inside the box that carries it, along one axis. | |
(ALPHA) | |
(ALPHA) Current version of PublisherDateStringV1. | |
(ALPHA) ISO 8601 calendar date (YYYY-MM-DD). | |
(ALPHA) Content of a document or a document template. It holds | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Current version of PublisherHeadingTypeV1. | |
(ALPHA) Size a heading is rendered at. Each size is styled by the matching theme text level ( | |
(ALPHA) | |
(ALPHA) Current version of PublisherImageFitV1. | |
(ALPHA) How an image is fitted to the area it is drawn in: kept whole inside it, filling it and cropped to do so, or stretched to its shape. | |
(ALPHA) Current version of PublisherImageSourceV1. | |
(ALPHA) What an image slot displays. | |
(ALPHA) Theme image reference or https URL. | |
(ALPHA) Current version of PublisherLayoutNodeV1. | |
(ALPHA) Node of a page’s layout tree: a recursive row/column split tree (flexbox semantics) over a fixed page. Leaves assign their area to slots; the tree carries geometry and box paint, slot content lives in IPublisherPageBodyV1.slots. | |
(ALPHA) | |
(ALPHA) Number from 0 to 1. | |
(ALPHA) | |
(ALPHA) Current version of PublisherPageFormatV1. | |
(ALPHA) Page shape a page template is designed for. | |
(ALPHA) Editor hint; it does not change how the page renders. | |
(ALPHA) Page size. The widescreen design canvas is 1920 × 1080 px. | |
(ALPHA) Current version of PublisherParagraphTypeV1. | |
(ALPHA) Size a paragraph is rendered at. Each size is styled by the matching theme text level ( | |
(ALPHA) Reported period, in the dashboard date filter grammar without a dataset. | |
(ALPHA) Length in px on the page’s design canvas, zero or more. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Current version of PublisherSlotV1. | |
(ALPHA) All slot types of document content version 1. | |
(ALPHA) Current version of PublisherTextSourceV1. | |
(ALPHA) Where the text of a text slot comes from. | |
(ALPHA) Named text style from the theme’s | |
(ALPHA) Current version of PublisherTextTypeV1. | |
(ALPHA) Size any document text is rendered at. | |
(ALPHA) A variable every document resolves, referenced from text as | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) Relative granularity offset (e.g. “GDC.time.year” granularity with offset -2 means “the previous 2 years”) | |
(ALPHA) Remote pluggable application registry item. Loaded via Module Federation. | |
(ALPHA) Pluggable application remote registry | |
(ALPHA) Entitlements and their values that must be set for the pluggable application to be accessible for the currently logged user. | |
(ALPHA) Organization permissions that must be set for the pluggable application to be accessible for the currently logged user. | |
(ALPHA) Settings and their values that must be set for the pluggable application to be accessible for the currently logged user. | |
(ALPHA) Workspace permissions and their values that must be set for the pluggable application to be accessible for the currently logged user. | |
(ALPHA) Supported email attachments | |
(ALPHA) Classification of the screen size according to its size with respect to the set breakpoints. | |
(ALPHA) Share permission. Hierarchy (highest → lowest): EDIT ⊃ SHARE ⊃ VIEW.
| |
(ALPHA) Object share status | |
Sorting direction. | |
Categorized collection of entity (object) identifiers referenced by a sort item. | |
Source insight filter reference. | |
Source measure-level filter reference. | |
(ALPHA) Union of text mode attribute filter types (arbitrary and match). | |
(BETA) Color string in hex format, e.g. #14b2e2 | |
(ALPHA) Information density of the dashboard layout. | |
(ALPHA) A length on the document page canvas, in px. Units are not accepted. | |
(BETA) Custom font URI which is used to override the default font | |
(ALPHA) Length used in rendered documents. | |
(BETA) Utility type to get IMdObjectDefinition from IMdObject. | |
(BETA) Utility type to transform INotificationChannelMetadataObjectDefinition to relevant INotificationChannelMetadataObject. | |
Supported types of totals. | |
(ALPHA) Reason why a referenced object is unavailable. | |
Type for all URI’s. | |
Model object reference using object’s URI. | |
(ALPHA) Union of all User Data Filter subtypes. User Data Filters are MAQL-based row-level security filters that can be assigned to a specific user or user group within a workspace. | |
(ALPHA) Union of all User Data Filter definition subtypes. | |
Visualization-specific properties. | |
Webhook recipient. | |
Week start day | |
(ALPHA) Widget attachment types. | |
Type of granted workspace granular access. | |
(ALPHA) Workspace access source values: directly assigned, inherited from a user group, or inherited from a parent workspace’s hierarchy permission. | |
Workspace permission types |