Class Pivotopia

Constructors

constructor

Properties

calculationCapabilities createValidatedDimensionAsMeasure createValidatedMeasure crossDefinitionChecks getAllAvailableFields getAllRequiredFields getValidatedDimensionGrouper getValidatedDimensions getValidatedFilterDefinition getValidatedFormatter getValidatedFormatterWithFormat getValidatedMeasures getValidatedScheme resultSetToHtmlTable validateCalculationOptions validateInputParameters validateRawDataObjects validateSorting

Methods

calculate getCalculationCapabilities getCustomJqlForConfig getDimensionDefinitionByName getDimensionValuesForScope getFilterDefinitionByName getFiltersForType getFormatterDefinitionByName getFormattersForType getGrouperDefinitionByName getGroupersForType getMeasureDefinitionByName getRequiredFieldsForConfig getRequiredSchemesForConfig getValidatedConfig

Constructors

constructor

Properties

Private calculationCapabilities

calculationCapabilities: any

Private createValidatedDimensionAsMeasure

createValidatedDimensionAsMeasure: any

Private createValidatedMeasure

createValidatedMeasure: any

Private crossDefinitionChecks

crossDefinitionChecks: any

Private getAllAvailableFields

getAllAvailableFields: any

Private getAllRequiredFields

getAllRequiredFields: any

Private getValidatedDimensionGrouper

getValidatedDimensionGrouper: any

Private getValidatedDimensions

getValidatedDimensions: any

Private getValidatedFilterDefinition

getValidatedFilterDefinition: any

Private getValidatedFormatter

getValidatedFormatter: any

Private getValidatedFormatterWithFormat

getValidatedFormatterWithFormat: any

Private getValidatedMeasures

getValidatedMeasures: any

Private getValidatedScheme

getValidatedScheme: any

resultSetToHtmlTable

resultSetToHtmlTable: ((resultSet, config) => string)

Type declaration

    • (resultSet, config): string

    • Parameters

      • resultSet: MatrixResultSet
      • config: ValidatedMatrixConfig

      Returns string

Private validateCalculationOptions

validateCalculationOptions: any

Private validateInputParameters

validateInputParameters: any

Private validateRawDataObjects

validateRawDataObjects: any

Private validateSorting

validateSorting: any

Methods

calculate

  • calculate(rawDataset, configInputParam, statusCallbackOrigin?): Promise<MatrixResultSet>

  • Parameters

    • rawDataset: AnyDataItem[]
    • configInputParam: ValidatedMatrixConfig | CalculationConfig
    • Optional statusCallbackOrigin: StatusCallbackFunction

    Returns Promise<MatrixResultSet>

getCalculationCapabilities

  • getCalculationCapabilities(): CalculationCapabilities

  • Returns CalculationCapabilities

getCustomJqlForConfig

  • getCustomJqlForConfig(config): undefined | string

  • Parameters

    • config: ValidatedMatrixConfig | CalculationConfig

    Returns undefined | string

getDimensionDefinitionByName

  • getDimensionDefinitionByName(dimensionName): undefined | DimensionDefinition

  • Parameters

    • dimensionName: string

    Returns undefined | DimensionDefinition

getDimensionValuesForScope

  • getDimensionValuesForScope(dimensionInputParam, dataSet): {
        displayValue: string;
        value: string | number;
    }[]

  • Parameters

    • dimensionInputParam: DimensionInputParam
    • dataSet: Record<string, unknown>[]

    Returns {
        displayValue: string;
        value: string | number;
    }[]

getFilterDefinitionByName

  • getFilterDefinitionByName(filterName): undefined | FilterDefinition

  • Parameters

    • filterName: string

    Returns undefined | FilterDefinition

getFiltersForType

  • getFiltersForType(expectedInputType): FilterDefinition[]

  • Parameters

    • expectedInputType: string

    Returns FilterDefinition[]

getFormatterDefinitionByName

  • getFormatterDefinitionByName(formatterName): undefined | FormatterDefinition

  • Parameters

    • formatterName: string

    Returns undefined | FormatterDefinition

getFormattersForType

  • getFormattersForType(expectedInputType): FormatterDefinition[]

  • Parameters

    • expectedInputType: string

    Returns FormatterDefinition[]

getGrouperDefinitionByName

  • getGrouperDefinitionByName(grouperName): undefined | DimensionGrouperDefinition

  • Parameters

    • grouperName: string

    Returns undefined | DimensionGrouperDefinition

getGroupersForType

  • getGroupersForType(expectedInputType): DimensionGrouperDefinition[]

  • Parameters

    • expectedInputType: string

    Returns DimensionGrouperDefinition[]

getMeasureDefinitionByName

  • getMeasureDefinitionByName(measureName): undefined | MeasureDefinition

  • Parameters

    • measureName: string

    Returns undefined | MeasureDefinition

getRequiredFieldsForConfig

  • getRequiredFieldsForConfig(config): string[]

  • Parameters

    • config: ValidatedMatrixConfig | CalculationConfig

    Returns string[]

getRequiredSchemesForConfig

  • getRequiredSchemesForConfig(config): string[]

  • Parameters

    • config: CalculationConfig

    Returns string[]

getValidatedConfig

  • getValidatedConfig(config): ValidatedMatrixConfig

  • Parameters

    • config: CalculationConfig

    Returns ValidatedMatrixConfig

Settings

Member Visibility

Theme

On This Page

constructorcalculationCapabilitiescreateValidatedDimensionAsMeasurecreateValidatedMeasurecrossDefinitionChecksgetAllAvailableFieldsgetAllRequiredFieldsgetValidatedDimensionGroupergetValidatedDimensionsgetValidatedFilterDefinitiongetValidatedFormattergetValidatedFormatterWithFormatgetValidatedMeasuresgetValidatedSchemeresultSetToHtmlTablevalidateCalculationOptionsvalidateInputParametersvalidateRawDataObjectsvalidateSortingcalculategetCalculationCapabilitiesgetCustomJqlForConfiggetDimensionDefinitionByNamegetDimensionValuesForScopegetFilterDefinitionByNamegetFiltersForTypegetFormatterDefinitionByNamegetFormattersForTypegetGrouperDefinitionByNamegetGroupersForTypegetMeasureDefinitionByNamegetRequiredFieldsForConfiggetRequiredSchemesForConfiggetValidatedConfig