@gooddata/sdk-code-convertors

Enumerations

Enumeration	Description
BucketsType
CoreErrorCode

Functions

Function	Description
assertUnreachable(x)
buildAfmExecution(entities, query)
convertBucketToTitle(entities, query, field, location)
createIdentifier(data, { forceMetric, forceType, }, input)
declarativeAttributeHierarchyToYaml(hierarchy, context)
declarativeComputedAttributeToYaml(computedAttribute)
declarativeDashboardToYaml(entities, dashboard, filterContexts, context)
declarativeDatasetToYaml(dataset, profile, tablesMap)
declarativeDateInstanceToYaml(dataset)
declarativeMetricToYaml(metric)
declarativeParameterToYaml(parameter)
declarativePluginToYaml(plugin)
declarativePublisherDocumentTemplateToYamlV2(template, errorContext)	*(ALPHA)* Converts a stored v2 document template to its as-code YAML.
declarativePublisherDocumentToYaml(publisherDocument)	*(ALPHA)*
declarativePublisherDocumentToYamlV2(document, errorContext)	*(ALPHA)* Converts a stored v2 document to its as-code YAML.
declarativePublisherPageLayoutToYaml(layout)	*(ALPHA)*
declarativePublisherPageTemplateToYamlV2(template, errorContext)	*(ALPHA)* Converts a stored v2 page template to its as-code YAML.
declarativeVisualisationToYaml(entities, visualisation, context)
fillPublisherIdsV2(content)	*(ALPHA)* Adds the section, page and widget ids a v2 document, document template or page template as code leaves out, so the YAML written by hand states the ids the stored entity keeps. An id counts as missing when it is absent, null or empty. Comments and the indent width survive, the line break of the first line is applied to the whole file, and the sequence style survives too, except that unindented sequences are kept only at a 2-space indent and the compact `-` style is not kept. Block scalars take the indent width of the maps. Content that needs no id, or does not parse, comes back unchanged.
fromDeclarativePermissions(permissions, hierarchyPermissions)
generateFileName(used, base, id, title)
getIdentifier(obj, untype, errorContext)
getValueOrDefault(value, defaultValue, type, undefinedAsDefault)
isDeclarativeCodeParameter(parameter)
isDeclarativeNumberParameter(parameter)
isDeclarativeStringParameter(parameter)
loadColorMapping(mappings)
loadColumnsWidth(widths)
parseGranularity(gran)
publisherDocumentDefinitionToYaml(publisherDocument)	*(ALPHA)* The same document, written from what the frontend holds: the object reference it is identified by becomes the bare id the YAML names it with.
publisherDocumentDefinitionToYamlV2(document, errorContext)	*(ALPHA)* Converts the v2 document the frontend holds to its as-code YAML. A document without a reference yet is written without an id.
publisherDocumentTemplateDefinitionToYaml(template)	*(ALPHA)*
publisherDocumentTemplateDefinitionToYamlV2(template, errorContext)	*(ALPHA)*
publisherPageLayoutDefinitionToYaml(layout)	*(ALPHA)* A reusable page. Its body is written at the top level, because the object it is already names it - a page written into a document names itself instead.
publisherPageTemplateDefinitionToYamlV2(template, errorContext)	*(ALPHA)*
resolveIdFromFileName(fileName)
saveColorMapping(mapping)
saveColumnWidths(fields, widths)
toDeclarativePermissions(permissions)
validateDeclarativePublisherEntityV2(entity)	*(ALPHA)* Validates a stored v2 document, document template or page template, named by the bare `id` the declarative API stores. It runs the sdk-model validator, and an issue on the reference is reported on `id`.
yamlAttributeHierarchyToDeclarative(input)
yamlComputedAttributeToDeclarative(input)
yamlDashboardToDeclarative(entities, input)
yamlDatasetToDeclarative(entities, input, dataSourceId)
yamlDateDatesetToDeclarative(input)
yamlMetricToDeclarative(input)
yamlParameterToDeclarative(input)
yamlPluginToDeclarative(input)
yamlPublisherDocumentTemplateToDeclarativeV2(input, errorContext)	*(ALPHA)* Converts a v2 document template as code to the stored document template.
yamlPublisherDocumentTemplateToDefinition(input, errorContext)	*(ALPHA)*
yamlPublisherDocumentTemplateToDefinitionV2(input, errorContext)	*(ALPHA)*
yamlPublisherDocumentToDeclarative(input, errorContext)	*(ALPHA)* Named for the document it reads, because a visualisation’s query convertor already owns the shorter name.
yamlPublisherDocumentToDeclarativeV2(input, errorContext)	*(ALPHA)* Converts a v2 document as code to the stored document.
yamlPublisherDocumentToDefinition(input, errorContext)	*(ALPHA)* The same document, as the frontend holds it: an object reference in place of the bare id the YAML names it by.
yamlPublisherDocumentToDefinitionV2(input, errorContext)	*(ALPHA)* Converts a v2 document as code to the definition the frontend holds: an object reference in place of the bare id. A document written without an id reads back without a reference.
yamlPublisherPageLayoutToDeclarative(input, errorContext)	*(ALPHA)*
yamlPublisherPageLayoutToDefinition(input, errorContext)	*(ALPHA)*
yamlPublisherPageTemplateToDeclarativeV2(input, errorContext)	*(ALPHA)* Converts a v2 page template as code to the stored page template.
yamlPublisherPageTemplateToDefinitionV2(input, errorContext)	*(ALPHA)*
yamlVisualisationToDeclarative(entities, input)
yamlVisualisationToMetadataObject(entities, input)

Interfaces

Interface	Description
IAbsoluteColumnWidth
IAllMeasureColumnWidthItem
IAllMeasureColumnWidthItemBody
IAttributeColumnLocator
IAttributeColumnLocatorBody
IAttributeColumnWidthItem
IAttributeColumnWidthItemBody
IAutoColumnWidth
ICoreError
IErrorContext
IMeasureColumnLocator
IMeasureColumnLocatorBody
IMeasureColumnWidthItem
IMeasureColumnWidthItemBody
IMixedValuesColumnWidthItem
IMixedValuesColumnWidthItemBody
ISliceMeasureColumnWidthItem
ISliceMeasureColumnWidthItemBody
ITotalColumnLocator
ITotalColumnLocatorBody
IWeakMeasureColumnWidthItem
IWeakMeasureColumnWidthItemBody

Variables

Variable	Description
CoreErrorMessages
CoreErrorTypes

Type Aliases

Type Alias	Description
AacAttributeHierarchy
AacComputedAttribute
AacDashboard
AacDashboardFilters
AacDataset
AacDateDataset
AacFilter
AacMetadata
AacMetric
AacParameter
AacPlugin
AacPublisherDocument	*(ALPHA)*
AacPublisherDocumentTemplate	*(ALPHA)*
AacPublisherDocumentTemplateV2	*(ALPHA)*
AacPublisherDocumentV2	*(ALPHA)*
AacPublisherEntityWithOptionalIdV2	*(ALPHA)* A v2 Publisher entity as code written before the entity has an id.
AacPublisherPageLayout	*(ALPHA)*
AacPublisherPageTemplateV2	*(ALPHA)*
AacQuery
AacSection
AacVisualisation
ColorMapping
ColumnLocator
ColumnWidth
ColumnWidthItem
DashboardTab
DeclarativeCodeParameter	A parameter AAC can represent as code: textual or numeric. Anything else has to stay under whatever tool created it.
DeclarativeEntityData	The declarative-API shape of any object AAC can carry; the counterpart of EntityData.
DeclarativeNumberParameter	A numeric parameter as the declarative API carries it.
DeclarativePublisherDocumentTemplateV2	*(ALPHA)* A document template as the declarative API stores it.
DeclarativePublisherDocumentV2	*(ALPHA)* A document as the declarative API stores it: the model’s definition named by a bare id.
DeclarativePublisherPageTemplateV2	*(ALPHA)* A page template as the declarative API stores it. The backend’s default page templates are not part of the declarative layout.
DeclarativeStringParameter	A textual parameter as the declarative API carries it.
EntityData	The YAML-side shape of any object AAC can carry; shared so entity types cannot drift apart.
ExportEntities
FileNamesUsed
FilePath
FromEntities
FullFields
GenericAssigneePermission
GenericAssigneeRulePermission
GenericPermission
LineStyleMapping
Permissions_2
Profile
ToExecutionResults
ValueType
VisualisationConfig