Class DimensionRegistryPreview

registerCustomDimension

• registerCustomDimension(typeId: string): void
  Early execution

  Parameters

  • typeId: string

    The namespaced identifier for the custom dimension (e.g., 'mypack:my_dimension'). Must include a namespace and use only valid identifier characters.

  Returns void

  Remarks

  Registers a new custom dimension type. Must be called during the system startup event. The dimension will be created using the void generator.

  Throws

  This function can throw errors.

  CustomDimensionAlreadyRegisteredError

  CustomDimensionInvalidRegistryError

  CustomDimensionNameError

  CustomDimensionReloadNewDimensionError

  EngineError

  NamespaceNameError