Skip to main content

Variable: strokeMessageSchema

const strokeMessageSchema: object

Defined in: src/lib/messages/schema.ts:128

JSON schema for a stroke message

Type Declaration​

$id​

readonly $id: "paintcanvas/message/stroke" = "paintcanvas/message/stroke"

additionalProperties​

readonly additionalProperties: false = false

properties​

readonly properties: object

properties.colour​

readonly colour: object

properties.colour.pattern​

readonly pattern: "^#[0-9a-fA-F]{6}$" = "^#[0-9a-fA-F]{6}$"

properties.colour.type​

readonly type: "string" = "string"

properties.isPen​

readonly isPen: object

properties.isPen.type​

readonly type: "boolean" = "boolean"

properties.layer​

readonly layer: object

properties.layer.maxLength​

readonly maxLength: 100 = 100

properties.layer.minLength​

readonly minLength: 1 = 1

properties.layer.type​

readonly type: "string" = "string"

properties.mode​

readonly mode: object

properties.mode.enum​

readonly enum: readonly ["paint", "erase"]

properties.points​

readonly points: object

properties.points.items​

readonly items: object

properties.points.items.additionalProperties​

readonly additionalProperties: false = false

properties.points.items.properties​

readonly properties: object

properties.points.items.properties.pressure​

readonly pressure: object

properties.points.items.properties.pressure.maximum​

readonly maximum: 1 = 1

properties.points.items.properties.pressure.minimum​

readonly minimum: 0 = 0

properties.points.items.properties.pressure.type​

readonly type: "number" = "number"

properties.points.items.properties.rotation​

readonly rotation: object = number

properties.points.items.properties.rotation.type​

readonly type: "number" = "number"

properties.points.items.properties.tiltX​

readonly tiltX: object

properties.points.items.properties.tiltX.maximum​

readonly maximum: 90 = 90

properties.points.items.properties.tiltX.minimum​

readonly minimum: -90 = -90

properties.points.items.properties.tiltX.type​

readonly type: "number" = "number"

properties.points.items.properties.tiltY​

readonly tiltY: object

properties.points.items.properties.tiltY.maximum​

readonly maximum: 90 = 90

properties.points.items.properties.tiltY.minimum​

readonly minimum: -90 = -90

properties.points.items.properties.tiltY.type​

readonly type: "number" = "number"

properties.points.items.properties.time​

readonly time: object = number

properties.points.items.properties.time.type​

readonly type: "number" = "number"

properties.points.items.properties.x​

readonly x: object = number

properties.points.items.properties.x.type​

readonly type: "number" = "number"

properties.points.items.properties.y​

readonly y: object = number

properties.points.items.properties.y.type​

readonly type: "number" = "number"

properties.points.items.required​

readonly required: readonly ["x", "y", "time"]

properties.points.items.type​

readonly type: "object" = "object"

properties.points.maxItems​

readonly maxItems: 100000 = MAX_STROKE_POINTS

properties.points.minItems​

readonly minItems: 1 = 1

properties.points.type​

readonly type: "array" = "array"

properties.preset​

readonly preset: object

properties.preset.$ref​

readonly $ref: "../stroke-preset" = "../stroke-preset"

properties.protocol​

protocol: object

properties.protocol.const​

readonly const: 2 = PROTOCOL_VERSION

properties.seed​

readonly seed: object

properties.seed.maximum​

readonly maximum: 4294967295 = 0xffffffff

properties.seed.minimum​

readonly minimum: 0 = 0

properties.seed.type​

readonly type: "integer" = "integer"

properties.size​

readonly size: object

properties.size.additionalProperties​

readonly additionalProperties: false = false

properties.size.properties​

readonly properties: object

properties.size.properties.height​

readonly height: object

properties.size.properties.height.maximum​

readonly maximum: 10000 = MAX_MESSAGE_CANVAS_SIZE

properties.size.properties.height.minimum​

readonly minimum: 0 = 0

properties.size.properties.height.type​

readonly type: "number" = "number"

properties.size.properties.width​

readonly width: object

properties.size.properties.width.maximum​

readonly maximum: 10000 = MAX_MESSAGE_CANVAS_SIZE

properties.size.properties.width.minimum​

readonly minimum: 0 = 0

properties.size.properties.width.type​

readonly type: "number" = "number"

properties.size.required​

readonly required: readonly ["width", "height"]

properties.size.type​

readonly type: "object" = "object"

properties.step​

step: object

properties.step.pattern​

readonly pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" = UUID_PATTERN

properties.step.type​

readonly type: "string" = "string"

properties.type​

readonly type: object

properties.type.const​

readonly const: "stroke" = CanvasMessageType.Stroke

required​

readonly required: readonly ["protocol", "type", "step", "layer", "mode", "preset", "size", "colour", "isPen", "seed", "points"]

type​

readonly type: "object" = "object"