Class Pivotopia

Constructors

constructor

new Pivotopia(calculationOptionsInputParams, options?): Pivotopia
Parameters
- calculationOptionsInputParams: CalculationCapabilitiesInputParam
- Optional options: PivotopiaOptions
Returns Pivotopia
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:4

Properties

`Private` calculationCapabilities

calculationCapabilities: any

`Private` cleanDatasetBeforeCalculation

cleanDatasetBeforeCalculation: 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` getValidatedMeasures

getValidatedMeasures: any

`Private` getValidatedScheme

getValidatedScheme: any

jiraIssuesToFlatObjects

jiraIssuesToFlatObjects: ((rawIssues) => {
    changelog: {};
    expand: undefined | string;
    id: string;
    key: string;
    self: string;
    worklog?: {
        worklogs?: JiraWorklog[];
    };
    worklogs: JiraWorklog[];
}[])

Type declaration

- (rawIssues): {
      changelog: {};
      expand: undefined | string;
      id: string;
      key: string;
      self: string;
      worklog?: {
          worklogs?: JiraWorklog[];
      };
      worklogs: JiraWorklog[];
  }[]
- Parameters
  - rawIssues: RawIssue<Partial<Pick<JiraIssueFields, "worklog">>>[]
  Returns {
      changelog: {};
      expand: undefined | string;
      id: string;
      key: string;
      self: string;
      worklog?: {
          worklogs?: JiraWorklog[];
      };
      worklogs: JiraWorklog[];
  }[]

resultSetToHtmlTable

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

Type declaration

- (resultSet, config): string
- Parameters
  - resultSet: ResultSet<AllJiraFields, Record<string, unknown>>
  - config: ValidatedCalculationConfig
  Returns string

`Private` validateCalculationOptions

validateCalculationOptions: any

`Private` validateInputParameters

validateInputParameters: any

`Private` validateRawDataObjects

validateRawDataObjects: any

`Private` validateSorting

validateSorting: any

Methods

addSerializedDimension

addSerializedDimension(serializedDimension): void
Parameters
- serializedDimension: SerializedDimensionDefinition
Returns void
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:8

addSerializedMeasure

addSerializedMeasure(serializedMeasure): void
Parameters
- serializedMeasure: SerializedMeasureDefinition
Returns void
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:9

calculate

calculate(rawDataset, configInputParam, statusCallbackOrigin?): Promise<ResultSet<AllJiraFields, Record<string, unknown>>>
Parameters
- rawDataset: Record<string, unknown>[]
- configInputParam: ValidatedCalculationConfig | CalculationInputParam
- Optional statusCallbackOrigin: StatusCallbackFunction
Returns Promise<ResultSet<AllJiraFields, Record<string, unknown>>>
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:5

getCalculationCapabilities

getCalculationCapabilities(): CalculationCapabilities
Returns CalculationCapabilities
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:7

getCustomJqlForConfig

getCustomJqlForConfig(config): undefined | string
Parameters
- config: ValidatedCalculationConfig | CalculationInputParam
Returns undefined | string
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:10

getDimensionDefinitionByName

getDimensionDefinitionByName(dimensionName): undefined | DimensionDefinition<Record<string, unknown>, Record<string, unknown>, string>
Parameters
- dimensionName: string
Returns undefined | DimensionDefinition<Record<string, unknown>, Record<string, unknown>, string>
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:13

getFilterDefinitionByName

getFilterDefinitionByName(filterName): undefined | FilterDefinition
Parameters
- filterName: string
Returns undefined | FilterDefinition
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:17

getFiltersForType

getFiltersForType(expectedInputType): FilterDefinition[]
Parameters
- expectedInputType: string
Returns FilterDefinition[]
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:20

getFormatterDefinitionByName

getFormatterDefinitionByName(formatterName): undefined | FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>
Parameters
- formatterName: string
Returns undefined | FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:16

getFormattersForType

getFormattersForType(expectedInputType): FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>[]
Parameters
- expectedInputType: string
Returns FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>[]
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:19

getGrouperDefinitionByName

getGrouperDefinitionByName(grouperName): undefined | DimensionGrouperDefinition
Parameters
- grouperName: string
Returns undefined | DimensionGrouperDefinition
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:15

getGroupersForType

getGroupersForType(expectedInputType): DimensionGrouperDefinition[]
Parameters
- expectedInputType: string
Returns DimensionGrouperDefinition[]
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:18

getMeasureDefinitionByName

getMeasureDefinitionByName(measureName): undefined | MeasureDefinition<AllJiraFields>
Parameters
- measureName: string
Returns undefined | MeasureDefinition<AllJiraFields>
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:14

getRequiredFieldsForConfig

getRequiredFieldsForConfig(config): string[]
Parameters
- config: ValidatedCalculationConfig | CalculationInputParam
Returns string[]
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:11

getRequiredSchemesForConfig

getRequiredSchemesForConfig(config): string[]
Parameters
- config: CalculationInputParam
Returns string[]
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:12

getValidatedConfig

getValidatedConfig(config): ValidatedCalculationConfig
Parameters
- config: CalculationInputParam
Returns ValidatedCalculationConfig
- Defined in actonic-pivotopia/dist/Pivotopia.d.ts:6

Class Pivotopia

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Pivotopia

Properties

Private calculationCapabilities

Private cleanDatasetBeforeCalculation

Private crossDefinitionChecks

Private getAllAvailableFields

Private getAllRequiredFields

Private getValidatedDimensionGrouper

Private getValidatedDimensions

Private getValidatedFilterDefinition

Private getValidatedFormatter

Private getValidatedMeasures

Private getValidatedScheme

jiraIssuesToFlatObjects

Type declaration

Parameters

Returns { changelog: {}; expand: undefined | string; id: string; key: string; self: string; worklog?: { worklogs?: JiraWorklog[]; }; worklogs: JiraWorklog[]; }[]

resultSetToHtmlTable

Type declaration

Parameters

Returns string

Private validateCalculationOptions

Private validateInputParameters

Private validateRawDataObjects

Private validateSorting

Methods

addSerializedDimension

Parameters

Returns void

addSerializedMeasure

Parameters

Returns void

calculate

Parameters

Returns Promise<ResultSet<AllJiraFields, Record<string, unknown>>>

getCalculationCapabilities

Returns CalculationCapabilities

getCustomJqlForConfig

Parameters

Returns undefined | string

getDimensionDefinitionByName

Parameters

Returns undefined | DimensionDefinition<Record<string, unknown>, Record<string, unknown>, string>

getFilterDefinitionByName

Parameters

Returns undefined | FilterDefinition

getFiltersForType

Parameters

Returns FilterDefinition[]

getFormatterDefinitionByName

Parameters

Returns undefined | FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>

getFormattersForType

Parameters

Returns FormatterDefinition<AllJiraFields, Record<string, unknown>, Record<string, unknown>>[]

getGrouperDefinitionByName

Parameters

Returns undefined | DimensionGrouperDefinition

getGroupersForType

Parameters

Returns DimensionGrouperDefinition[]

getMeasureDefinitionByName

Parameters

Returns undefined | MeasureDefinition<AllJiraFields>

getRequiredFieldsForConfig

Parameters

Returns string[]

getRequiredSchemesForConfig

Parameters

Returns string[]

getValidatedConfig

Parameters

`Private` calculationCapabilities

`Private` cleanDatasetBeforeCalculation

`Private` crossDefinitionChecks

`Private` getAllAvailableFields

`Private` getAllRequiredFields

`Private` getValidatedDimensionGrouper

`Private` getValidatedDimensions

`Private` getValidatedFilterDefinition

`Private` getValidatedFormatter

`Private` getValidatedMeasures

`Private` getValidatedScheme

Returns {
changelog: {};
expand: undefined | string;
id: string;
key: string;
self: string;
worklog?: {
worklogs?: JiraWorklog[];
};
worklogs: JiraWorklog[];
}[]

`Private` validateCalculationOptions

`Private` validateInputParameters

`Private` validateRawDataObjects

`Private` validateSorting