r:default-dimension-value

  1. The XBRL Standard
  2. XBRL Specifications
  3. Registries
  4. Functions Registry 1.0
  5. Functions Registry
  6. r:default-dimension-value

xs:QName*=r:default-dimension-value( $dimension as xs:QName)

Last updated on 25-05-2023 at 00:00:00.

Returns the default value for a dimension

OIM 1.0

OIM Status

Exclusive - this function is only available in OIM Mode

Parameters

Name Type Details
dimension xs:QName The dimension to return the default value for.

Output

Type: xs:QName*

The default value for dimension, if any. If there is no default value, an empty sequence is returned. Note that it is not an error to supply an OIM Core dimension, or a typed taxonomy-defined dimension, but this function will always return an empty sequence for such dimensions.

Errors

Code Details
re:invalidDimension Error thrown if the specified QName does not correspond to either an OIM Core Dimension, or a taxonomy-defined dimension defined in the DTS of the report.

Owners

Name Affiliation Email Start End
Paul Warren XBRL International pdw@xbrl.org 25-05-2023 at 00:00:00