Overview of sdk-model
sdk-model package
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 |
|---|---|
| ArithmeticMeasureBuilder | Builder for arithmetic measures. Do not instantiate this builder directly, instead use newArithmeticMeasure(). |
| AttributeBuilder | Builder for attributes. Do not instantiate this class directly. Instead use newAttribute() or modifyAttribute(). |
| InlineMeasureBuilder | Builder for inline measures. Do not instantiate this builder directly, instead use newMeasure() or modifyMeasure() functions. |
| MeasureBuilder | Builder for simple measures. Do not instantiate this builder directly, instead use newMeasure() or modifyMeasure() functions. |
| PoPMeasureBuilder | Builder for period-over-period measures. Do not instantiate this builder directly, instead use newPopMeasure(). |
| PreviousPeriodMeasureBuilder | Builder for previous period measures. Do not instantiate this builder directly, instead use newPreviousPeriodMeasure(). |
Abstract Classes
| Abstract Class | Description |
|---|---|
| MeasureBuilderBase | Abstract base class for measure builders. Measure builders allow for incremental, fluent construction and modification of measures. |
Enumerations
| Enumeration | Description |
|---|---|
| ComputeRatioRule | Defines possible compute ratio sanitization rules. |
Functions
| Function | Description |
|---|---|
| absoluteDateFilterValues(filter) | Gets effective values of an absolute date filter. |
| applyRatioRule(items, rule) | Applies compute ratio rule to all measures in a list. |
| areObjRefsEqual(a, b) | 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. |
| attributeAlias(attribute) | Gets an attribute alias. |
| attributeDescriptorLocalId(descriptor) | Returns local identifier of attribute described in the provided attribute descriptor. |
| attributeDescriptorName(descriptor) | Returns name of attribute described in the provided attribute descriptor. |
| attributeDisplayFormMetadataObjectAttributeRef(displayForm) | Gets ObjRef of the attribute the display form is a form of. |
| attributeDisplayFormMetadataObjectRef(displayForm) | Gets the attribute display form's ObjRef |
| attributeDisplayFormMetadataObjectTitle(displayForm) | Gets the attribute display form's title. |
| attributeDisplayFormRef(attribute) | Gets an attribute display form object ref. |
| attributeIdentifier(attribute) | Gets identifier of attribute's display form to use and get attribute element values from. |
| attributeLocalId(attributeOrId) | Gets local identifier of an attribute. |
| attributeLocatorElement(locator) | Given attribute locator, return the element that it references. |
| attributeLocatorIdentifier(locator) | Given attribute locator, return the localId of attribute that it references. |
| attributesFind(attributes, idOrFun) | Given list of attributes, returns first-found attribute matching the provided predicate. |
| attributeShowAllValues(attribute) | Gets an attribute show all values property. |
| attributeUri(attribute) | Gets URI of attribute's display form to use and get attribute element values from. |
| bucketAttribute(bucket, idOrFun) | Gets first attribute matching the provided predicate from the bucket. |
| bucketAttributeIndex(bucket, idOrFun) | Gets the index of the first attribute matching the provided predicate from the bucket. |
| bucketAttributes(bucket, predicate) | Gets all attributes matching the provided predicate from the bucket. |
| bucketIsEmpty(bucket) | Tests whether the provided bucket is empty = contains no items and no totals. |
| bucketItemLocalId(bucketItem) | Gets value of local identifier of bucketItem |
| bucketItemReduce(bucket, reducer) | Creates a new bucket by modifying items of the provided input bucket. |
| bucketItems(bucket) | Gets all attributes and measures from the bucket. |
| bucketMeasure(bucket, idOrFun) | Gets first measure matching the provided predicate from the bucket. |
| bucketMeasureIndex(bucket, idOrFun) | Gets the index of the first measure matching the provided predicate from the bucket. |
| bucketMeasures(bucket, predicate) | Gets all measures matching the provided predicate from the bucket. |
| bucketModifyItems(bucket, modifications) | Creates a new bucket by modifying items of the provided input bucket. |
| bucketsAttributes(buckets, predicate) | Gets all attributes matching the provided predicate from a list of buckets. |
| bucketsById(buckets, ids) | Gets buckets with the provided local identifiers from a list of buckets. |
| bucketSetTotals(bucket, totals) | Gets a new bucket that 'inherits' all data from the provided bucket but has different totals. |
| bucketsFind(buckets, idOrFun) | Finds bucket matching the provided predicate in a list of buckets. |
| bucketsFindAttribute(buckets, idOrFun) | Finds attribute matching the provided predicate in a list of buckets. |
| bucketsFindMeasure(buckets, idOrFun) | Finds measure matching the provided predicate in a list of buckets. |
| bucketsIsEmpty(buckets) | Tests whether all buckets in a list are empty (meaning neither has any items or totals defined) |
| bucketsItems(buckets) | Gets all attributes and measures from a list of buckets. |
| bucketsMeasures(buckets, predicate) | Gets all measures matching the provided predicate from a list of buckets. |
| bucketsModifyItem(buckets, modifications) | Creates a new array of buckets, each bucket in the array contains modified bucket items (retrieved by applying the modifications function to the bucketItem). |
| bucketsReduceItem(buckets, reducer) | Creates a new array of buckets, each bucket in the array contains modified bucket items |
| bucketsTotals(buckets) | Gets all totals from a list of buckets |
| bucketTotals(bucket) | Gets all totals from the bucket |
| colorPaletteItemToRgb(item) | Returns RGB code representing the color in the provided color palette items. |
| colorPaletteToColors(palette) | Returns a list of RGB color codes for all items in the provided color palette. |
| defaultDimensionsGenerator(definition) | Default dimension generator for execution definition behaves as follows: |
| defFingerprint(def) | Calculates fingerprint for the execution definition. |
| defSetDimensions(def, dimensions) | Creates new execution definition by slapping the provided dimensions on top of the definition. |
| defSetExecConfig(def, config) | Creates new execution definition by merging new exection configuration into an existing definition. |
| defSetPostProcessing(def, postProcessing) | Creates new execution definition by setting a new post processing. |
| defSetSorts(def, sortBy) | Creates new execution definition by merging new sort items into an existing definition. |
| defTotals(def, dimIdx) | Gets totals from particular dimension in the provided execution definition. |
| defWithDateFormat(definition, dateFormat) | Changes the dateFormat of a postProcessing, other properties of postProcessing (if any) remain unchanged. |
| defWithDimensions(definition, dims) | Configures dimensions in the exec definition. |
| defWithExecConfig(definition, config) | Changes additional execution configuration in the definition. |
| defWithFilters(def, filters) | Creates new execution definition by merging new filters into an existing definition. |
| defWithPostProcessing(definition, postProcessing) | Changes the postProcessing of a definition. |
| defWithSorting(definition, sorts) | Changes sorting in the definition. Any sorting settings accumulated so far WILL be wiped out. |
| deserializeObjRef(val) | Deserializes an ObjRef from its pure string representation. |
| dimensionSetTotals(dim, totals) | Creates a new dimension which has same items as the provided dimension but different totals. |
| dimensionsFindItem(dims, localId) | Looks for item with the provided local identifier among the dimensions. |
| dimensionTotals(dim) | Gets totals defined in the provided dimension |
| disableComputeRatio(item) | Disables compute ratio if set on a simple measure. Does not do anything for other measures. |
| emptyDef(workspace) | Creates new, empty execution definition for the provided workspace. |
| filterAttributeElements(filter) | Gets attribute elements specified on the attribute filter. |
| filterAttributeElements(filter) | Gets attribute elements specified on a filter. If the provided filter is not an attribute filter, then undefined is returned |
| filterIsEmpty(filter) | Tests whether the provided attribute element does not specify any attribute elements. |
| filterMeasureRef(filter) | Gets reference to a measure being used for filtering if the provided filter is measure based. For other filters return undefined. |
| filterObjRef(filter) | Gets reference to object being used for filtering. |
| filterObjRef(filter) | Gets reference to object being used for filtering. |
| idRef(identifier, type) | Creates an IdentifierRef from object identifier and given object type. |
| insightAttributes(insight, attributePredicate) | Gets all attributes used in the provided insight |
| insightBucket(insight, idOrFun) | Finds bucket matching the provided predicate in an insight. |
| insightBuckets(insight, ids) | Gets buckets for the insight. If ids are provided, then only returns buckets matching the ids. |
| insightCreated(insight) | Gets the date when the insight was created |
| insightCreatedBy(insight) | Gets the user that created the insight |
| insightDisplayFormUsage(insight) | Gets references to all display forms used by the insight. |
| insightFilters(insight) | Gets filters used in an insight. |
| insightHasAttributes(insight) | Tests whether insight uses any attributes |
| insightHasDataDefined(insight) | Tests whether insight contains valid definition of data to visualise - meaning at least one attribute or one measure is defined in the insight. |
| insightHasMeasures(insight) | Tests whether insight uses any measures. |
| insightId(insight) | Gets the insight id |
| insightIsLocked(insight) | Checks if insight is locked |
| insightItems(insight) | Gets all attributes and measures used in the provided insight. |
| insightMeasures(insight, measurePredicate) | Gets all measures used in the provided insight. |
| insightModifyItems(insight, modifications) | Creates a new insight with modified bucket items (retrieved by applying the modifications function to each bucketItem in the insight). |
| insightProperties(insight) | Gets visualization properties of an insight. |
| insightReduceItems(insight, reducer) | Creates a new insight with reduced bucket items (retrieved by applying the modifications function). |
| insightRef(insight) | Gets opaque reference to the insight. |
| insightSanitize(insight) | Makes sure the insight does not have any nonsensical data (like totals that no longer make sense, etc.), before it is saved. |
| insightSetBuckets(insight, buckets) | Gets a new insight that 'inherits' all data from the provided insight but has different buckets. |
| insightSetFilters(insight, filters) | Gets a new insight that 'inherits' all data from the provided insight but has different filters. |
| insightSetProperties(insight, properties) | Gets a new insight that 'inherits' all data from the provided insight but has different properties. |
| insightSetSorts(insight, sorts) | Gets a new insight that 'inherits' all data from the provided insight but has different sorts. |
| insightSorts(insight) | Gets sorting defined in the insight. |
| insightSummary(insight) | Gets the insights summary |
| insightTags(insight) | Gets the insights tags from the tagging system |
| insightTitle(insight) | Gets the insight title |
| insightTotals(insight) | Gets all totals defined in the insight |
| insightUpdated(insight) | Gets the date of the last insight update |
| insightUpdatedBy(insight) | Gets the user that last updated the insight |
| insightUri(insight) | Gets the insight uri |
| isAbsoluteDateFilter(obj) | Type guard checking whether the provided object is an absolute date filter. |
| isAdhocMeasure(obj) | Type guard for checking whether object is an adhoc measure. |
| isAllTimeDateFilter(obj) | Type guard checking whether the provided object is an all time date filter. |
| isArithmeticMeasure(obj) | Type guard for checking whether object is an arithmetic measure. |
| isArithmeticMeasureDefinition(obj) | Type guard for checking whether object is an arithmetic measure definition. |
| isAttribute(obj) | Type guard checking whether object is an instance of IAttribute. |
| isAttributeAreaSort(obj) | Type guard checking whether an object is an attribute area sort item. |
| isAttributeDescriptor(obj) | Type-guard testing whether the provided object is an instance of IAttributeDescriptor. |
| isAttributeDisplayFormMetadataObject(obj) | Tests whether the provided object is of type IAttributeDisplayFormMetadataObject. |
| isAttributeElementsByRef(obj) | Type guard checking whether the provided object is list of attribute elements specified by URI reference. |
| isAttributeElementsByValue(obj) | Type guard checking whether the provided object is list of attribute elements specified by their text value. |
| isAttributeFilter(obj) | Type guard checking whether the provided object is an attribute filter. |
| isAttributeLocator(obj) | Type guard checking whether an object is an attribute locator. |
| isAttributeMetadataObject(obj) | Tests whether the provided object is of type IAttributeMetadataObject. |
| isAttributeSort(obj) | Type guard checking whether an object is an attribute sort item. |
| isAttributeValueSort(obj) | Type guard checking whether an object is a normal attribute value sort item, not the area one. |
| isBucket(obj) | Type-guard testing whether the provided object is an instance of IBucket. |
| isCatalogAttribute(obj) | Type guard checking whether the provided object is a ICatalogAttribute |
| isCatalogDateDataset(obj) | Type guard checking whether object is an instance of ICatalogDateDataset. |
| isCatalogFact(obj) | Type guard checking whether the provided object is a ICatalogFact |
| isCatalogMeasure(obj) | Type guard checking whether the provided object is a ICatalogMeasure |
| isColorDescriptor(obj) | Type-guard testing whether the provided object is an instance of IColorDescriptor. |
| isColorFromPalette(obj) | Type guard checking whether the provided object is a IColorFromPalette |
| isColorMappingItem(obj) | Type guard checking whether the provided object is an IColorMappingItem. |
| isColorPaletteItem(obj) | Type guard checking whether the provided object is a IColorPaletteItem |
| isComparisonCondition(obj) | Type guard checking whether the provided object is a measure value filter's comparison condition. |
| isComparisonConditionOperator(obj) | Type guard checking whether the provided operator is a measure value filter's comparison operator. |
| isDashboardMetadataObject(obj) | Tests whether the provided object is of type IDashboardMetadataObject. |
| isDataSetMetadataObject(obj) | Tests whether the provided object is of type IDataSetMetadataObject. |
| isDateFilter(obj) | Type guard checking whether the provided object is a date filter. |
| isDimension(obj) | Type guard checking whether object is of IDimension type. |
| isFactMetadataObject(obj) | Tests whether the provided object is of type IFactMetadataObject. |
| isFilter(obj) | Type guard checking whether the provided object is a filter. |
| isIdentifierRef(obj) | Type guard checking whether object is an Identifier Reference. |
| isInlineMeasure(obj) | Type guard for checking whether object is a inline measure. |
| isInlineMeasureDefinition(obj) | Type guard for checking whether object is a inline measure definition. |
| isInsight(obj) | Type guard checking whether the provided object is an Insight. |
| isLocalIdRef(obj) | Type guard checking whether object is a localId Reference. |
| isMeasure(obj) | Type guard for checking whether object is any type of measure. |
| isMeasureDefinition(obj) | Type guard for checking whether object is a measure definition. |
| isMeasureDescriptor(obj) | Type-guard testing whether the provided object is an instance of IMeasureDescriptor. |
| isMeasureFormatInPercent(measureOrFormat) | Gets a flag indicating whether a given measure has a format resulting in data being formatted as percentage |
| isMeasureGroupDescriptor(obj) | Type-guard testing whether the provided object is an instance of IMeasureGroupDescriptor. |
| isMeasureLocator(obj) | Type guard checking whether an object is measure locator |
| isMeasureMetadataObject(obj) | Tests whether the provided object is of type IMeasureMetadataObject. |
| isMeasureMetadataObjectDefinition(obj) | Tests whether the provided object is of type IMeasureMetadataObjectDefinition. |
| isMeasureSort(obj) | Type guard checking whether an object is a measure sort item. |
| isMeasureValueFilter(obj) | Type guard checking whether the provided object is a measure value filter. |
| isMetadataObject(obj) | Type guard checking whether input is an instance of IMetadataObject. |
| isNegativeAttributeFilter(obj) | Type guard checking whether the provided object is a negative attribute filter. |
| isObjRef(obj) | Type guard checking whether object is an Identifier Reference or an URI reference. |
| isPoPMeasure(obj) | Type guard for checking whether object is a period-over-period measure. |
| isPoPMeasureDefinition(obj) | Type guard for checking whether object is a period-over-period measure definition. |
| isPositiveAttributeFilter(obj) | Type guard checking whether the provided object is a positive attribute filter. |
| isPreviousPeriodMeasure(obj) | Type guard for checking whether object is a previous-period measure. |
| isPreviousPeriodMeasureDefinition(obj) | Type guard for checking whether object is a previous period measure definition. |
| isRangeCondition(obj) | Type guard checking whether the provided object is a measure value filter's range condition. |
| isRangeConditionOperator(obj) | Type guard checking whether the provided object is a measure value filter's range condition operator. |
| isRankingFilter(obj) | Type guard checking whether the provided object is a ranking filter. |
| isRelativeDateFilter(obj) | Type guard checking whether the provided object is a relative date filter. |
| isResultAttributeHeader(obj) | Type-guard testing whether the provided object is an instance of IResultAttributeHeader. |
| isResultMeasureHeader(obj) | Type-guard testing whether the provided object is an instance of IResultMeasureHeader. |
| isResultTotalHeader(obj) | Type-guard testing whether the provided object is an instance of IResultTotalHeader. |
| isRgbColor(obj) | Type guard checking whether the provided object is a IRgbColor |
| isSimpleMeasure(obj) | Type guard for checking whether object is a simple measure. |
| isTotal(obj) | Type-guard checking whether an object is a Total. |
| isTotalDescriptor(obj) | Type-guard testing whether the provided object is an instance of ITotalDescriptor. |
| isTotalLocator(obj) | Type guard checking whether an object is a total locator. |
| isUriRef(obj) | Type guard checking whether object is an URI Reference. |
| isVariableMetadataObject(obj) | Tests whether the provided object is of type IVariableMetadataObject. |
| localIdRef(localIdentifier) | Creates an LocalIdRef from a local identifier |
| measureAggregation(measure) | Gets measure aggregation from a measure. |
| measureAlias(measure) | Gets measure alias. |
| measureArithmeticOperands(measure) | Gets identifiers of arithmetic operands from the provided arithmetic measure. |
| measureArithmeticOperands(measure) | Gets identifiers of arithmetic operands from the provided measure. If the measure is not an arithmetic measure, then undefined is returned. |
| measureArithmeticOperator(measure) | Gets arithmetic operator from the provided arithmetic measure. |
| measureArithmeticOperator(measure) | Gets arithmetic operator from the provided measure. |
| measureDoesComputeRatio(measure) | Tests whether the measure is set to compute ratio. |
| measureFilters(measure) | Gets measure filters. |
| measureFormat(measure) | Gets measure format. |
| measureIdentifier(measure) | Gets identifier of persistent measure. |
| measureItem(measure) | Gets reference of LDM object from which the measure is calculated (fact or MAQL metric). |
| measureItem(measure) | Gets reference of LDM object from which the measure is calculated (fact or MAQL metric). |
| measureLocalId(measureOrLocalId) | Gets measure's local identifier. For convenience and fluency, this function accepts both measure object and identifier object. |
| measureLocatorIdentifier(locator) | Given measure locator, return the localId of measure that it references. |
| measureMasterIdentifier(measure) | Gets identifier of master measure for the provided PoP measure or Previous Period measure. |
| measureMasterIdentifier(measure) | Gets identifier of master measure for the provided derived measure (PoP measure or Previous Period measure). |
| measurePopAttribute(measure) | Gets attribute used for period-over-period measure calculation. |
| measurePopAttribute(measure) | Gets attribute used for period-over-period measure calculation. |
| measurePreviousPeriodDateDataSets(measure) | Gets date data sets used in previous-period measure. |
| measurePreviousPeriodDateDataSets(measure) | Gets date data sets used in previous-period measure. |
| measureTitle(measure) | Gets measure title. |
| measureUri(measure) | Gets URI of persistent measure. |
| measureValueFilterCondition(filter) | Gets measure value filter condition. |
| measureValueFilterMeasure(filter) | Gets measure value filter measure. |
| measureValueFilterOperator(filter) | Gets operator used in measure value filter condition. |
| modifyAttribute(attribute, modifications) | Allows modification of an existing attribute instance. |
| modifyInlineMeasure(measure, modifications) | Creates a new inline measure by applying modifications on top of an existing measure. |
| modifyMeasure(measure, modifications) | Creates a new measure by applying modifications on top of an existing measure. |
| modifyPopMeasure(measure, modifications) | Creates a new PoP measure by applying modifications on top of an existing measure. |
| modifyPreviousPeriodMeasure(measure, modifications) | Creates a new Previous Period measure by applying modifications on top of an existing measure. |
| modifySimpleMeasure(measure, modifications) | Creates a new simple measure by applying modifications on top of an existing measure. |
| newAbsoluteDateFilter(dateDataSet, from, to) | Creates a new absolute date filter. |
| newAllTimeFilter(dateDataSet) | 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. |
| newArithmeticMeasure(measuresOrIds, operator, modifications) | Creates a new arithmetic measure with the specified measure identifiers and operator and optional modifications and localIdentifier. |
| newAttribute(displayFormRefOrId, modifications) | 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. |
| newAttributeLocator(attributeOrId, element) | Creates a new attribute locator for an attribute element. |
| newAttributeSort(attributeOrId, sortDirection) | Creates a new attribute sort - sorting the result by values of the provided attribute's elements. |
| newBucket(localId, content) | Creates a new bucket with the provided id and all the specified content. |
| newDefForBuckets(workspace, buckets, filters) | Prepares a new execution definition for a list of buckets. |
| newDefForInsight(workspace, insight, filters) | Prepares a new execution definition for the provided insight. |
| newDefForItems(workspace, items, filters) | Prepares a new execution definition for a list of attributes and measures, filtered using the provided filters. |
| newDimension(items, totals) | Creates new single-dimensional specification where the dimension will have the provided set of identifiers. |
| newInlineMeasure(maql) | Creates a new inline measure |
| newMeasure(measure, modifications) | 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. |
| newMeasureSortFromLocators(locators, sortDirection) | 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. |
| newNegativeAttributeFilter(attributeOrRef, notInValues) | 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) | 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. |
| newRankingFilter(measureOrRef, attributesOrRefs, operator, value) | Creates a new ranking filter. |
| newRankingFilter(measureOrRef, operator, value) | Creates a new ranking filter. |
| newRelativeDateFilter(dateDataSet, granularity, from, to) | Creates a new relative date filter. |
| newTotal(type, measureOrId, attributeOrId, alias) | Creates a new total. |
| newTwoDimensional(dim1Input, dim2Input) | Creates new two dimensional specification where each dimension will have the provided set of identifiers. |
| relativeDateFilterValues(filter) | Gets effective values of a relative date filter. |
| resultHeaderName(header) | Returns item name contained within a result header. |
| serializeObjRef(objRef) | Serializes an instance of ObjRef to a string representation. |
| sortDirection(sort) | Gets sort item's direction |
| sortEntityIds(sort) | Given sort item, returns ids of entities (objects) that are referenced by the sort item. |
| sortMeasureLocators(sort) | Given a measure sort item, return the locators which identify the measure (possibly scoped for particular attribute element). |
| totalIsNative(total) | Tests whether total instance represents a native total = a roll-up total. |
| uriRef(uri) | Creates an UriRef from an URI |
| userFullName(user) | Gets the user full name |
| visClassId(vc) | For given visualization class, return its identifier. |
| visClassUri(vc) | For given visualization class, return its URI. |
| visClassUrl(vc) | For given visualization class, return URL where the vis assets are stored. |
Interfaces
| Interface | Description |
|---|---|
| IAbsoluteDateFilter | Filters results to an absolute date range - from one fixed date to another. |
| IAbsoluteDateFilterValues | Represents values of an absolute filter. |
| IArithmeticMeasureDefinition | Arithmetic measures are created by composing two or more other measures and defining arithmetic to apply on their values. |
| IAttribute | Attribute is our nomenclature for 'dimension' as typically used in multi-dimensional BI modeling. |
| IAttributeBody | Attribute is our nomenclature for 'dimension' as typically used in multi-dimensional BI modeling. |
| IAttributeDescriptor | Describes attribute slicing of a dimension. |
| IAttributeDescriptorBody | Attribute descriptor header. |
| IAttributeDisplayFormMetadataObject | Attribute display form metadata object |
| IAttributeElement | Attribute element represented by concrete display form |
| IAttributeElementsByRef | Attribute elements specified by their URI. |
| IAttributeElementsByValue | Attribute elements specified by their textual value. |
| IAttributeHeaderFormOf | Describes attributes to which the display form belongs. |
| IAttributeLocatorItem | Locator that specifies a concrete attribute element for which the measure values are sliced. |
| IAttributeLocatorItemBody | Locator that specifies a concrete attribute element for which the measure values are sliced. |
| IAttributeMetadataObject | Attribute metadata object |
| IAttributeSortItem | Sort item which specifies that the result should be sorted by attribute element values in either ascending or descending order. |
| IAttributeSortTarget | Attribute sort target. |
| IAttributeSortType | Attribute sort type specification. |
| IAuditableDates | Object that can provide information about the users that created or modified it and when those actions occurred. |
| IAuditableUsers | Object that can provide information about the users that created or modified it and when those actions occurred. |
| IBucket | Bucket is a logical, user-defined grouping of attributes, measures and totals. |
| ICatalogAttribute | Type representing catalog attribute |
| ICatalogDateAttribute | Type representing catalog dateDataset date attribute |
| ICatalogDateDataset | Type representing catalog date dataset |
| ICatalogFact | Type representing catalog fact |
| ICatalogGroup | Catalog group can be used to group catalog items |
| ICatalogItemBase | Properties contained in each catalog item |
| ICatalogMeasure | Type representing catalog measure |
| IColorDescriptor | Describes color included in a dimension. |
| IColorDescriptorItem | Describes color included in a dimension. |
| IColorFromPalette | Color defined by referencing an item in the user-defined color palette. |
| IColorMappingItem | 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. |
| IColorPaletteItem | An item in user-defined color palette. Item is essentially mapping of user-assigned color identifier to an RGB Color value. |
| IComparisonCondition | |
| IComparisonConditionBody | |
| IDashboardAttributeFilter | Attribute filter of the filter context |
| IDashboardAttributeFilterParent | (BETA) Parent filter of an attribute filter of the filter context |
| IDashboardDateFilter | Date filter of the filter context |
| IDashboardMetadataObject | Dashboard metadata object |
| IDataColumn | Dataset column with name, type and boolean flag whether the column needs to be skipped while data loading or not. |
| IDataColumnBody | Data column object interface. |
| IDataHeader | Structural information about CSV header and columns. |
| IDataset | Dataset describes a particular structure of dataset (CSV file). |
| IDatasetBody | Dataset object interface. |
| IDatasetLoadInfo | Object wrapping basic information (owner, date created, status) about a CSV Load. |
| IDataSetMetadataObject | DataSet metadata object |
| IDatasetUser | Object wrapping info about the user that created CSV load. Contains their login and full name. |
| IDimension | Dimensions specify how to organize the results of an execution in a data view. |
| IDimensionDescriptor | Dimension descriptor is the output counter-part of the dimension specification that was included in the execution definition. |
| IEntitlementDescriptor | Entitlement descriptor |
| IExecutionConfig | Contains any configiration that should be part of execution |
| IExecutionDefinition | Execution definition contains 100% complete description of what will the execution compute and how will the resulting data look like. |
| IFactMetadataObject | Fact metadata object |
| IGranteeGranularity | Access grantee specification with granular permissions. |
| IGranularUserAccessGrantee | User access grantee specification with granular permissions. |
| IGranularUserGroupAccessGrantee | User group access grantee specification with granular permissions. |
| IGroupableCatalogItemBase | Properties contained in each groupable catalog item |
| IInlineMeasureDefinition | Inline measures are defined as MAQL measures inline string. |
| IMeasure | All types of measures have a set of common properties; those are defined here. |
| IMeasureBody | Object defining the IMeasure object structure. |
| IMeasureDefinition | Simple measures are defined from existing MAQL measures or logical data model facts. |
| IMeasureDefinitionBody | Object defining the IMeasureDefinition object structure. |
| IMeasureDescriptor | Describes measure included in a dimension. |
| IMeasureDescriptorItem | Measure descriptor object. |
| IMeasureDescriptorObject | Descriptor of the measure and its contents. |
| IMeasureGroupDescriptor | Describes measure group and its contents. |
| IMeasureLocatorItem | Locator that specifies a concrete measure to sort by. |
| IMeasureLocatorItemBody | Object defining the IMeasureLocatorItem object structure. |
| IMeasureMetadataObjectBase | |
| IMeasureSortItem | Sort item which specifies that the result should be sorted by value of a measure. |
| IMeasureSortTarget | Measure sort target. |
| IMeasureTitle | Subset of IMeasure interface which defines properties that MAY be used to provide human readable description of the measure. |
| IMeasureTitleBody | Object defining the IMeasureTitle object body. |
| IMeasureValueFilter | |
| IMeasureValueFilterBody | Object defining the IMeasureValueFilter object body. |
| IMetadataObject | |
| IMetadataObjectBase | |
| IMetadataObjectDefinition | |
| IMetadataObjectIdentity | |
| INegativeAttributeFilter | Negative attribute filter essentially adds an NOT IN <set> condition to the execution on the backend. |
| INegativeAttributeFilterBody | Object defining the INegativeAttributeFilter object body. |
| IOrganizationDescriptor | Organization descriptor contains details about the organization that services analytical workspaces. |
| IPoPMeasureDefinition | Defines Period-Over-Period measure (or Time-over-Time). |
| IPoPMeasureDefinitionBody | Object defining the IPoPMeasureDefinition object body. |
| IPositiveAttributeFilter | Positive attribute filter essentially adds an IN <set> condition to the execution on the backend. |
| IPositiveAttributeFilterBody | Object defining the IPositiveAttributeFilter object body. |
| IPostProcessing | 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. |
| IPreviousPeriodDateDataSet | This is used to specify previous period. |
| IPreviousPeriodDateDataSetSimple | Simplified Previous Period Data DataSet specification |
| IPreviousPeriodMeasureDefinition | This is a derived measure that calculates value of a measure referenced by measureIdentifier for previous period. |
| IPreviousPeriodMeasureDefinitionBody | Object defining the IPreviousPeriodMeasureDefinition object body. |
| IRangeCondition | |
| IRangeConditionBody | Object defining the IRangeCondition object body. |
| IRankingFilter | |
| IRankingFilterBody | Object defining the IRankingFilter object body. |
| IRelativeDateFilterValues | Represents values of a relative filter. |
| IResultAttributeHeader | Attribute header specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong. |
| IResultAttributeHeaderItem | Attribute header item specifies name and URI of the attribute element to which the calculated measure values in the particular data view slice belong. |
| IResultMeasureHeader | Measure header specifies name of the measure to which the calculated values in the particular data view slice belong. |
| IResultMeasureHeaderItem | Measure header specifies name of the measure to which the calculated values in the particular data view slice belong. |
| IResultTotalHeader | Total header specifies name and type of total to which the calculated values in particular data view slice belong. |
| IResultTotalHeaderItem | 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. |
| IResultWarning | Represents an execution result warning. (e.g. when execution was executed successfully, but backend didn't take something into the account) |
| IRgbColor | Color defined used RGB values. |
| IRgbColorValue | RGB Color value specification. |
| ISeparators | Settings for regional number formatting |
| ISettings | Settings are obtained from backend and are effectively a collection of feature flags or settings with concrete string or numeric value. |
| ISortDirection | Sorting direction part of sort. |
| ITheme | (BETA) Theme used to customize selected parts of the UI |
| IThemeAnalyticalDesigner | (BETA) Analytical designer specific properties. |
| IThemeAnalyticalDesignerTitle | (BETA) Analytical designer title specific properties. |
| IThemeButton | (BETA) Button customizable UI properties |
| IThemeChart | (BETA) Charts customization |
| IThemeColorFamily | (BETA) Variants of the palette color |
| IThemeComplementaryPalette | (BETA) Used to color various elements across many components by replacing the default complementary palette of gray color shades |
| IThemeDashboard | (BETA) KPI dashboards specific properties |
| IThemeDashboardContent | (BETA) Dashboard content customizable properties. |
| IThemeDashboardContentKpi | (BETA) Dashboard content KPI customizable properties. |
| IThemeDashboardContentWidget | (BETA) Dashboard content widget customizable properties. |
| IThemeDashboardEditPanel | (BETA) Edit panel specific properties. |
| IThemeDashboardFilterBar | (BETA) Dashboard filterBar customizable properties. |
| IThemeDashboardFilterBarButton | (BETA) Filter bar button specific properties |
| IThemeDashboardNavigation | (BETA) Navigation customizable properties. |
| IThemeDashboardNavigationItem | (BETA) Navigation items (dashboards) specific properties. |
| IThemeDashboardNavigationTitle | (BETA) Dashboard navigation title specific properties. |
| IThemeDashboardSection | (BETA) Dashboard section customizable properties. |
| IThemeDashboardSectionDescription | (BETA) Dashboard section description properties. |
| IThemeDashboardSectionTitle | (BETA) Dashboard section title properties. |
| IThemeDashboardTitle | (BETA) Dashboard title specific properties. |
| IThemeKpi | (BETA) Kpi values customization |
| IThemeKpiValue | (BETA) Kpi value specific properties. |
| IThemeModal | (BETA) Modal customizable properties. |
| IThemeModalTitle | (BETA) Properties of the title of the modal. |
| IThemePalette | (BETA) Customizable palette of major colors Inspired by Material UI palette: https://material-ui.com/customization/palette/ |
| IThemeTable | (BETA) Table customization |
| IThemeTooltip | (BETA) Tooltip customizable UI properties |
| IThemeTypography | (BETA) Definition of both normal and bold font URIs |
| IThemeWidgetTitle | (BETA) Title of the widget |
| ITotal | Describes type and granularity for calculation of Totals. |
| ITotalDescriptor | Describes total included in a dimension. |
| ITotalDescriptorItem | Describes total included in a dimension. |
| ITotalLocatorItem | Locator that specifies a concrete total element for which the measure values are sliced. |
| ITotalLocatorItemBody | Locator that specifies a concrete attribute element for which the total is applicable |
| IUser | Represents platform user. |
| IUserAccessGrantee | User access grantee specification. |
| IUserGroupAccessGrantee | User group access grantee specification. |
| IVariableMetadataObject | Variable metadata object |
| IVisualizationClass | Visualization class is essentially a descriptor for particular type of visualization - say bar chart or table. |
| IVisualizationClassBody | Object defining the IVisualizationClass object body. |
| IWhiteLabeling | Configuration of WhiteLabeling. |
| IWorkspaceUser | Represents platform user in context of the workspace. |
Variables
| Variable | Description |
|---|---|
| anyAttribute | Predicate that returns true for any attribute. |
| anyBucket | This predicate evaluates true for any bucket. |
| anyMeasure | Implementation of measure predicate which always returns true. |
| catalogItemMetadataObject | Get metadata object that catalog item represents |
| DateGranularity | Defines shortcuts for commonly used date dataset attribute granularities. |
| factoryNotationFor | Returns a code for generating the provided input using convenience factory methods where possible. |
| idMatchAttribute | Factory function for attribute predicate which evaluates true for attributes that match particular ID. |
| idMatchBucket | Factory function for predicates that will evaluate true if bucket's id is same as the provided id. |
| idMatchMeasure | Factory function for measure predicate which evaluates true for measures that match particular ID. |
| insightCreatedByComparator | (BETA) |
| insightCreatedComparator | (BETA) |
| insightTitleComparator | (BETA) |
| insightUpdatedByComparator | (BETA) |
| insightUpdatedComparator | (BETA) |
| isMeasureGroupIdentifier | Determine if a given item is a measure group. |
| isUserAccessGrantee | Tests whether the provided object is an instance of IUserAccessGrantee. |
| isUserGroupAccessGrantee | Tests whether the provided object is an instance of IUserGroupAccessGrantee. |
| MeasureGroupIdentifier | Measure Group is a pseudo-identifier which can be used in an execution dimension and indicates that this dimension MUST contain all the measures. |
| metadataObjectId | Get metadata object identifier |
Type Aliases
| Type Alias | Description |
|---|---|
| AccessGranularPermission | Type of granted granular access. |
| AllTimeGranularity | Special granularity used to indicate there should be no date filtering for the given dimension. |
| ArithmeticMeasureBuilderInput | Input to the ArithmeticMeasureBuilder. |
| ArithmeticMeasureOperator | Simple math operators for arithmetic measure construction. |
| AttributeBuilderInput | Input to the AttributeBuilder. |
| AttributeDisplayFormType | Attribute display form type |
| AttributeInBucket | Describes exact location of attribute in a bucket. |
| AttributeModifications | Function that will be called to perform modifications of an attribute before it is fully constructed. |
| AttributePredicate | Defines function signature for measure predicates. |
| BucketItemModifications | Describes the type of the function used to modify the bucket items. |
| BucketItemReducer | Describes the type of the function used to reduce the bucket items. |
| BucketPredicate | Signature for bucket predicates; predicates are used by different functions to find/filter buckets according to some criteria. |
| CatalogItem | Type representing catalog item - attribute, measure, fact or dateDataset |
| CatalogItemType | Type representing catalog item type - attribute, measure, fact or dateDataset |
| ComparatorDirection | Direction of the comparator. |
| ComparisonConditionOperator | |
| DashboardAttributeFilterSelectionMode | (BETA) Attribute filter selection mode value |
| DataColumnType | Represents type of LDM field created from the Dataset column. |
| DatasetLoadStatus | Represents the current status of CSV source. |
| DataValue | Single calculated data value. |
| DateAttributeGranularity | All possible date dataset attribute granularities. |
| DateFilterAbsoluteType | (BETA) Date filter type - absolute |
| DateFilterGranularity | (BETA) Supported date filter granularity for the relative date filter |
| DateFilterRelativeType | (BETA) Date filter type - relative |
| DateFilterType | (BETA) Date filter type - relative or absolute |
| DateString | (BETA) Date string - ISO-8601 calendar date string, eg.: '2018-12-30' |
| DimensionGenerator | Function transforming a list of buckets (with attributes and measures) into execution dimension descriptors. |
| DimensionItem | Defines union of items that can be placed into a dimension. |
| GroupableCatalogItem | Type representing groupable catalog item - attribute, measure or fact |
| GuidType | |
| IAccessGrantee | Access grantee specification. |
| IAttributeElements | 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. |
| IAttributeFilter | Attribute filters limit results of execution to data pertaining to attributes that are or are not specified by the filters. |
| IAttributeOrMeasure | Type representing bucket items - which can be either measure or an attribute. |
| IAuditable | Object that can provide information about the users that created or modified it and when those actions occurred. |
| IColor | A color. It can be specified by referencing an item from from user-defined color palette or by RGB Value. |
| IColorPalette | User-defined color palette. Colors from the palette can be used as input to charts and naturally influence the coloring strategy for the chart. |
| IComparator | Function that can be used to sort collections. The semantics are the same as the first argument to Array#sort function. |
| IDateFilter | Date filters limit the range of results to data within relative or absolute date range. |
| Identifier | Type for all identifiers. |
| IdentifierRef | Model object reference using object's unique identifier. NOTE: this is preferred way to reference model objects. |
| IDimensionItemDescriptor | Headers describing contents of a dimension. |
| IEntitlementsName | Entitlement name |
| IFilter | All possible filters. |
| IGranularAccessGrantee | Access grantee with granular permission. |
| IInsight | Represents an Insight defined in GoodData platform. Insight is typically created using Analytical Designer and can be embedded using UI SDK. |
| IInsightDefinition | Insight definition specifies what and how should be visualized by an insight. |
| ILocatorItem | Locators are used to identify slice of measure values to sort by. |
| IMeasureDefinitionType | Available measure definitions; this is union of simple measure, arithmetic measure, PoP measure and previous period measure. |
| IMeasureFilter | All possible filters that can be specified for a simple measure. |
| IMeasureMetadataObject | Measure metadata object |
| IMeasureMetadataObjectDefinition | Measure metadata object definition |
| InlineMeasureBuilderInput | Input to the InlineMeasureBuilder. |
| InsightDisplayFormUsage | Contains breakdown of what display forms are used in an insight. |
| INullableFilter | Represents a filter specification variant where either the actual filter or a 'null' filter is provided. Null filters will be ignored during processing. |
| IRelativeDateFilter | Filters results to a relative date range. |
| IResultHeader | Result headers provide metadata about data included in the data view. |
| ISortItem | Sort items can be used to specify how the result of an execution should be sorted. |
| ItemInDimension | Result of search of item among list of dimensions. |
| IWorkspacePermissions | Dictionary of workspace permissions |
| LocalIdRef | Model object reference using object's local identifier. |
| MeasureAggregation | Simple measures created from facts can use these types of aggregations. |
| MeasureEnvelope | Measure without the definition. |
| MeasureInBucket | Describes exact location of measure in a bucket. |
| MeasureModifications | Function that will be called to perform modifications of measure before it is fully constructed. |
| MeasureOrLocalId | Specification of measure either by value or by local id reference. |
| MeasurePredicate | Defines function signature for measure predicates. |
| MeasureValueFilterCondition | |
| MetadataObject | Type that represents any metadata object |
| ObjectType | Metadata object types |
| ObjRef | Model object reference. |
| ObjRefInScope | Model object reference with support of referencing objects living in the same scope using their local identifier. |
| PlatformEdition | Indicates current platform edition. |
| PoPMeasureBuilderInput | Input to the PoPMeasureBuilder. |
| PreviousPeriodMeasureBuilderInput | Import to the PreviousPeriodMeasureBuilder. |
| RangeConditionOperator | |
| RankingFilterOperator | |
| RgbType | |
| SortDirection | Sorting direction. |
| SortEntityIds | Categorized collection of entity (object) identifiers referenced by a sort item. |
| ThemeColor | (BETA) Color string in hex format, e.g. #14b2e2 |
| ThemeFontUri | (BETA) Custom font URI which is used to override the default font |
| TotalType | Supported types of totals. |
| Uri | Type for all URI's. |
| UriRef | Model object reference using object's URI. |
| VisualizationProperties | Visualization-specific properties. |
| WeekStart | Week start day |
| WorkspacePermission | Workspace permission types |