Documentation for definitions

Showing:

Annotations

Diagram

Properties

Constraints

Enumerations

Compositions

Used By

Source

Definition FloorplanRoom

Annotations

Title  FloorplanRoom

Description  A description for single room for this floorplan.

Diagram

Type

object

Properties

Name	Occurrence
Type Name OriginalName DesiredShape	required required optional optional

Additional Properties

false

Used by

Schema

FloorplanTemplate/properties/Rooms/items

FloorplanTemplate/properties/Rooms

Source


 "FloorplanRoom": {
  "type": "object",
  "additionalProperties": false,
  "title": "FloorplanRoom",
  "description": "A description for single room for this floorplan.",
  "required": [
    "Type",
    "Name"
  ],
  "properties": {
    "Type": {
      "title": "Type",
      "type": "string",
      "enum": [
        "Bathroom",
        "Kitchen",
        "Living",
        "Closet",
        "Bedroom",
        "Dining",
        "Hallway"
      ]
    },
    "Name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_\\- ]*$",
      "title": "Name"
    },
    "OriginalName": {
      "type": "string",
      "title": "Originalname"
    },
    "DesiredShape": {
      "title": "Desiredshape",
      "default": {
        "Area": 20,
        "AspectRatio": {
          "x": 1,
          "y": 1
        }
      },
      "allOf": [
        {"$ref": "#/definitions/Rectangle"}
      ]
    }
  }
}

Definition Type

Annotations

Title  Type

Diagram

Type

string

Enumeration

Values

Bathroom

Kitchen

Living

Closet

Bedroom

Dining

Hallway

Used by

Schema

FloorplanRoom

Source


 "Type": {
  "title": "Type",
  "type": "string",
  "enum": [
    "Bathroom",
    "Kitchen",
    "Living",
    "Closet",
    "Bedroom",
    "Dining",
    "Hallway"
  ]
}

Definition Name

Annotations

Title  Name

Diagram

Type

string

Constraints

Min Length : 1

Max Length : 255

Pattern : ^[a-zA-Z0-9_\- ]*$

Used by

Schema

FloorplanRoom

Source


 "Name": {
  "type": "string",
  "minLength": 1,
  "maxLength": 255,
  "pattern": "^[a-zA-Z0-9_\\- ]*$",
  "title": "Name"
}

Definition OriginalName

Annotations

Title  Originalname

Diagram

Type

string

Used by

Schema

FloorplanRoom

Source


 "OriginalName": {
  "type": "string",
  "title": "Originalname"
}

Definition DesiredShape

Annotations

Title  Desiredshape

Diagram

Type

object

Constraints

Default : {Area=20.0, AspectRatio={x=1.0, y=1.0}}

All of

Choices

DesiredShape : Schema (0)

Additional Properties

false

Used by

Schema

FloorplanRoom

Source


 "DesiredShape": {
  "title": "Desiredshape",
  "default": {
    "Area": 20,
    "AspectRatio": {
      "x": 1,
      "y": 1
    }
  },
  "allOf": [
    {"$ref": "#/definitions/Rectangle"}
  ]
}

Definition allOf/0

Diagram

Type

reference

Refers

Rectangle

Used by

Schema

FloorplanRoom/properties/DesiredShape

Source


{"$ref": "#/definitions/Rectangle"}