# garden.lexicon.dazzling-boarfish.rating.scale

> Published by [tynanpurdy.com](https://lexicon.garden/identity/did:plc:6ayddqghxhciedbaofoxkcbs)

✓ This is the authoritative definition for this NSID.

## Description

Defines what makes a valid rating value for a scale — the value's shape and measurement level.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:6ayddqghxhciedbaofoxkcbs/garden.lexicon.dazzling-boarfish.rating.scale)
- [Documentation](https://lexicon.garden/lexicon/did:plc:6ayddqghxhciedbaofoxkcbs/garden.lexicon.dazzling-boarfish.rating.scale/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:6ayddqghxhciedbaofoxkcbs/garden.lexicon.dazzling-boarfish.rating.scale/examples)

## Definitions

### `garden.lexicon.dazzling-boarfish.rating.scale#interval`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `max` | `integer` | Yes |  |
| `maxLabel` | `string` | No | Optional label for the maximum value. |
| `maxLabelImage` | `object` | No | Optional image for the maximum endpoint (blob reference). |
| `min` | `integer` | Yes |  |
| `minLabel` | `string` | No | Optional label for the minimum value. |
| `minLabelImage` | `object` | No | Optional image for the minimum endpoint (blob reference). |
| `unit` | `string` | No |  |
| `unitsPerWhole` | `integer` | Yes | Divide the stored integer by this to get the value in `unit`s. Any positive integer, not just a power of 10. Choose min/max directly in the smallest (or coarsest) legal increment — every integer between min and max is then a valid value, by construction. |

### `garden.lexicon.dazzling-boarfish.rating.scale#intervalValue`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `value` | `integer` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale`

**Type**: `record`

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `code` | `union` | Yes |  |
| `createdAt` | `string` (datetime) | No |  |
| `description` | `string` | No |  |
| `documentation` | `string` (uri) | No | Optional URI linking to further documentation about this scale (e.g. methodology, citations). |
| `langs` | `array` | No | BCP-47 tag(s) the name/description/option labels in this scale are written in. |
| `name` | `string` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#nominal`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `options` | `array` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#nominalOption`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `description` | `string` | No |  |
| `label` | `string` | Yes |  |
| `labelImage` | `object` | No | Optional image for this option (blob reference). |
| `value` | `string` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#nominalValue`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `value` | `string` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#ordinal`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `options` | `array` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#ordinalOption`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `description` | `string` | No |  |
| `label` | `string` | Yes |  |
| `labelImage` | `object` | No | Optional image for this option (blob reference). |
| `value` | `integer` | Yes | Rank. Leave gaps for future insertions. |

### `garden.lexicon.dazzling-boarfish.rating.scale#ordinalValue`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `value` | `integer` | Yes |  |

### `garden.lexicon.dazzling-boarfish.rating.scale#ratio`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `max` | `integer` | Yes |  |
| `maxLabel` | `string` | No | Optional label for the maximum value. |
| `maxLabelImage` | `object` | No | Optional image for the maximum endpoint (blob reference). |
| `min` | `integer` | Yes |  |
| `minLabel` | `string` | No | Optional label for the minimum value (true absence). |
| `minLabelImage` | `object` | No | Optional image for the minimum endpoint (blob reference). |
| `unit` | `string` | No |  |
| `unitsPerWhole` | `integer` | Yes | Divide the stored integer by this to get the value in `unit`s. Choose min/max directly in the smallest (or coarsest) legal increment so that every integer between min and max is then a valid value. |

### `garden.lexicon.dazzling-boarfish.rating.scale#ratioValue`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `value` | `integer` | Yes |  |

## Raw Schema

```json
{
  "defs": {
    "interval": {
      "properties": {
        "max": {
          "type": "integer"
        },
        "maxLabel": {
          "description": "Optional label for the maximum value.",
          "maxLength": 128,
          "type": "string"
        },
        "maxLabelImage": {
          "description": "Optional image for the maximum endpoint (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "min": {
          "type": "integer"
        },
        "minLabel": {
          "description": "Optional label for the minimum value.",
          "maxLength": 128,
          "type": "string"
        },
        "minLabelImage": {
          "description": "Optional image for the minimum endpoint (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "unit": {
          "maxLength": 64,
          "type": "string"
        },
        "unitsPerWhole": {
          "description": "Divide the stored integer by this to get the value in `unit`s. Any positive integer, not just a power of 10. Choose min/max directly in the smallest (or coarsest) legal increment — every integer between min and max is then a valid value, by construction.",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "min",
        "max",
        "unitsPerWhole"
      ],
      "type": "object"
    },
    "intervalValue": {
      "properties": {
        "value": {
          "type": "integer"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "main": {
      "key": "tid",
      "record": {
        "properties": {
          "code": {
            "refs": [
              "#nominal",
              "#ordinal",
              "#interval",
              "#ratio"
            ],
            "type": "union"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "maxLength": 1024,
            "type": "string"
          },
          "documentation": {
            "description": "Optional URI linking to further documentation about this scale (e.g. methodology, citations).",
            "format": "uri",
            "maxLength": 1024,
            "type": "string"
          },
          "langs": {
            "description": "BCP-47 tag(s) the name/description/option labels in this scale are written in.",
            "items": {
              "format": "language",
              "type": "string"
            },
            "maxItems": 3,
            "type": "array"
          },
          "name": {
            "maxLength": 256,
            "type": "string"
          }
        },
        "required": [
          "name",
          "code"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "nominal": {
      "properties": {
        "options": {
          "items": {
            "ref": "#nominalOption",
            "type": "ref"
          },
          "maxItems": 100,
          "type": "array"
        }
      },
      "required": [
        "options"
      ],
      "type": "object"
    },
    "nominalOption": {
      "properties": {
        "description": {
          "maxLength": 256,
          "type": "string"
        },
        "label": {
          "maxLength": 128,
          "type": "string"
        },
        "labelImage": {
          "description": "Optional image for this option (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "value": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "label",
        "value"
      ],
      "type": "object"
    },
    "nominalValue": {
      "properties": {
        "value": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "ordinal": {
      "properties": {
        "options": {
          "items": {
            "ref": "#ordinalOption",
            "type": "ref"
          },
          "maxItems": 100,
          "type": "array"
        }
      },
      "required": [
        "options"
      ],
      "type": "object"
    },
    "ordinalOption": {
      "properties": {
        "description": {
          "maxLength": 256,
          "type": "string"
        },
        "label": {
          "maxLength": 128,
          "type": "string"
        },
        "labelImage": {
          "description": "Optional image for this option (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "value": {
          "description": "Rank. Leave gaps for future insertions.",
          "type": "integer"
        }
      },
      "required": [
        "label",
        "value"
      ],
      "type": "object"
    },
    "ordinalValue": {
      "properties": {
        "value": {
          "type": "integer"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "ratio": {
      "properties": {
        "max": {
          "type": "integer"
        },
        "maxLabel": {
          "description": "Optional label for the maximum value.",
          "maxLength": 128,
          "type": "string"
        },
        "maxLabelImage": {
          "description": "Optional image for the maximum endpoint (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "min": {
          "type": "integer"
        },
        "minLabel": {
          "description": "Optional label for the minimum value (true absence).",
          "maxLength": 128,
          "type": "string"
        },
        "minLabelImage": {
          "description": "Optional image for the minimum endpoint (blob reference).",
          "properties": {
            "mimeType": {
              "type": "string"
            },
            "ref": {
              "type": "cid-link"
            },
            "size": {
              "type": "integer"
            }
          },
          "type": "object"
        },
        "unit": {
          "maxLength": 64,
          "type": "string"
        },
        "unitsPerWhole": {
          "description": "Divide the stored integer by this to get the value in `unit`s. Choose min/max directly in the smallest (or coarsest) legal increment so that every integer between min and max is then a valid value.",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "min",
        "max",
        "unitsPerWhole"
      ],
      "type": "object"
    },
    "ratioValue": {
      "properties": {
        "value": {
          "type": "integer"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    }
  },
  "description": "Defines what makes a valid rating value for a scale — the value's shape and measurement level.",
  "id": "garden.lexicon.dazzling-boarfish.rating.scale",
  "lexicon": 1
}
```