gooddata-js v13.5.0

DataLayer Class

Defined in: src/DataLayer/index.ts:17

Module: DataLayer

Data layer

Index
Methods

Show: Inherited Protected Private Deprecated

Methods

appendFilters
applySorting
createSubject
dateFiltersDataSetsMatch
getDateFilterDateDataSet
getGlobalDateFilters
getId
getMeasureDateFilters
hasFilters
hasGlobalDateFilter
hasMetricDateFilters
isAfmExecutable
isArithmeticMeasure
isAttributeFilter deprecated
isAttributeFilterSelectAll
isDateFilter deprecated
isPoP
isPreviousPeriodMeasure
isSimpleMeasure
isSortValid
normalizeAfm
toAfmResultSpec
unwrapArithmeticMeasure
unwrapPoPMeasure
unwrapPreviousPeriodMeasure
unwrapSimpleMeasure

Show: Inherited Protected Private Deprecated

`appendFilters`

(

afm
attributeFilters
dateFilter
measureValueFilters

)

AFM.IAfm

Defined in src/DataLayer/utils/AfmUtils.ts:281

Append attribute filters and date filter to afm

Date filter handling: - Override if date filter has the same id - Add if date filter if date filter id is different

Attribute filter handling: - Add all

Parameters

afm AFM.IAfm
attributeFilters AFM.AttributeFilterItem
dateFilter AFM.DateFilterItem
measureValueFilters AFM.IMeasureValueFilter

Returns

AFM.IAfm:

`applySorting`

(

resultSpec
sortItems

)

AFM.IResultSpec

Defined in src/DataLayer/utils/ResultSpecUtils.ts:5

Attaches sorts into resultSpec

Parameters

resultSpec AFM.IResultSpec
sortItems AFM.SortItem

Returns

AFM.IResultSpec:

`createSubject`

(

successHandler
errorHandler

)

ISubject>

Defined in src/DataLayer/utils/async.ts:16

Creates infinite stream Usage: const subject = createSubject( (result) => console.log('Success:', result), (error) => console.error('Error:', error) ); subject.next(promise1); subject.next(promise2);

subject.unsubscribe();

Parameters

successHandler StreamSuccessHandler
errorHandler StreamErrorHandler

Returns

ISubject>:

`dateFiltersDataSetsMatch`

(

f1
f2

)

AFM.ObjQualifier | null | boolean

Defined in src/DataLayer/utils/AfmUtils.ts:260

Returns true if dateFilters dataSets match

Parameters

f1 AFM.DateFilterItem
f2 AFM.DateFilterItem

Returns

AFM.ObjQualifier | null | boolean:

`getDateFilterDateDataSet`

(

filter

)

AFM.ObjQualifier | null

Defined in src/DataLayer/utils/AfmUtils.ts:243

Returns date filter date dataset

Parameters

filter AFM.DateFilterItem

Returns

AFM.ObjQualifier | null:

`getGlobalDateFilters`

(

normalizedAfm

)

AFM.DateFilterItem

Defined in src/DataLayer/utils/AfmUtils.ts:176

Returns global date filters

Parameters

normalizedAfm INormalizedAFM

Returns

AFM.DateFilterItem:

`getId`

(

obj

)

String | Null

Defined in src/DataLayer/utils/AfmUtils.ts:226

Return uri or identifier from ObjQualifier

Parameters

obj AFM.ObjQualifier

Returns

String | Null:

`getMeasureDateFilters`

(

normalizedAfm

)

AFM.DateFilterItem

Defined in src/DataLayer/utils/AfmUtils.ts:198

Return date filters from AFM

Parameters

normalizedAfm AFM.IAfm

Returns

AFM.DateFilterItem:

`hasFilters`

(

measure

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:187

Returns true if measure has filters

Parameters

measure AFM.ISimpleMeasure

Returns

Boolean:

`hasGlobalDateFilter`

(

afm

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:215

Return true if AFM has global date filter

Parameters

afm INormalizedAFM

Returns

Boolean:

`hasMetricDateFilters`

(

normalizedAfm

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:159

Returns true if measure has dateFilters

Parameters

normalizedAfm INormalizedAFM

Returns

Boolean:

`isAfmExecutable`

(

afm

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:345

Returns true if AFM is executable

Parameters

afm AFM.IAfm

Returns

Boolean:

`isArithmeticMeasure`

(

item

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:108

Returns true if measure is arithmetic measure

Parameters

item AFM.IMeasure

Returns

Boolean:

`isAttributeFilter`

(

filter

)

Boolean deprecated

Defined in src/DataLayer/utils/AfmUtils.ts:119

Deprecated: use AFM.isAttributeFilter instead

Returns true if filter is attributeFilter

Parameters

filter AFM.FilterItem

Returns

Boolean:

`isAttributeFilterSelectAll`

(

filter

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:143

Returns true if filter is negative attribute filter and has no selected elements, meaning that this is "Select all"

Parameters

filter AFM.FilterItem

Returns

Boolean:

`isDateFilter`

(

filter

)

Boolean deprecated

Defined in src/DataLayer/utils/AfmUtils.ts:131

Deprecated: use AFM.isDateFilter instead

Returns true if filter is dateFilter

Parameters

filter AFM.CompatibilityFilter

Returns

Boolean:

`isPoP`

(

item

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:86

Returns true if measure is PeriodOverPeriod

Parameters

item AFM.IMeasure

Returns

Boolean:

`isPreviousPeriodMeasure`

(

item

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:97

Returns true if measure is previous period measure

Parameters

item AFM.IMeasure

Returns

Boolean:

`isSimpleMeasure`

(

item

)

Boolean

Defined in src/DataLayer/utils/AfmUtils.ts:75

Returns true if measure is a simple measure

Parameters

item AFM.IMeasure

Returns

Boolean:

`isSortValid`

(

afm
sortItem

)

Boolean

Defined in src/DataLayer/utils/ResultSpecUtils.ts:52

Returns true if sortItem fits to afm

Parameters

afm AFM.IAfm
sortItem AFM.SortItem

Returns

Boolean:

`normalizeAfm`

(

afm

)

INormalizedAFM

Defined in src/DataLayer/utils/AfmUtils.ts:59

Normalize AFM

Parameters

afm AFM.IAfm

Returns

INormalizedAFM:

`toAfmResultSpec`

(

visObj

)

IConvertedAFM

Defined in src/DataLayer/converters/toAfmResultSpec.ts:183

Converts visualizationObject to afm and resultSpec

Parameters

visObj VisualizationObject.IVisualizationObjectContent

Returns

IConvertedAFM:

`unwrapArithmeticMeasure`

(

item

)

AFM.IArithmeticMeasure

Defined in src/DataLayer/utils/AfmUtils.ts:48

Unwraps arithmeticMeasure object

Parameters

item AFM.IMeasure

Returns

AFM.IArithmeticMeasure:

`unwrapPoPMeasure`

(

item

)

AFM.IPopMeasure

Defined in src/DataLayer/utils/AfmUtils.ts:26

Unwraps popMeasure object

Parameters

item AFM.IMeasure

Returns

AFM.IPopMeasure:

`unwrapPreviousPeriodMeasure`

(

item

)

AFM.IPreviousPeriodMeasure

Defined in src/DataLayer/utils/AfmUtils.ts:37

Unwraps previousPeriodMeasure object

Parameters

item AFM.IMeasure

Returns

AFM.IPreviousPeriodMeasure:

`unwrapSimpleMeasure`

(

item

)

AFM.ISimpleMeasure

Defined in src/DataLayer/utils/AfmUtils.ts:15

Unwraps measure object

Parameters

item AFM.IMeasure

Returns

AFM.ISimpleMeasure: