pub.leaflet.blocks.drawing

leaflet.pub

Documentation

Freehand ink strokes. The view box is the area of drawing space the block shows, scaled to the block's width; strokes may reach past it.

main object

Freehand ink strokes. The view box is the area of drawing space the block shows, scaled to the block's width; strokes may reach past it.

Properties

fills array of ref#fill Optional

Painted in order, beneath the strokes.

strokes array of ref#stroke Required

No description available.

viewBox ref #viewBox Required

No description available.

View raw schema
{
  "description": "Freehand ink strokes. The view box is the area of drawing space the block shows, scaled to the block's width; strokes may reach past it.",
  "properties": {
    "fills": {
      "description": "Painted in order, beneath the strokes.",
      "items": {
        "ref": "#fill",
        "type": "ref"
      },
      "type": "array"
    },
    "strokes": {
      "items": {
        "ref": "#stroke",
        "type": "ref"
      },
      "type": "array"
    },
    "viewBox": {
      "ref": "#viewBox",
      "type": "ref"
    }
  },
  "required": [
    "viewBox",
    "strokes"
  ],
  "type": "object"
}
fill object

A filled polygon, painted with the nonzero rule: the region a stroke encloses.

Properties

color string Required

A CSS hex color, or one of the document theme's colors: primary (text), accent, or tertiary (faded text).

points array of integer Required

Flattened vertices as x, y pairs in drawing space. The last joins back to the first.

View raw schema
{
  "description": "A filled polygon, painted with the nonzero rule: the region a stroke encloses.",
  "properties": {
    "color": {
      "description": "A CSS hex color, or one of the document theme's colors: primary (text), accent, or tertiary (faded text).",
      "type": "string"
    },
    "points": {
      "description": "Flattened vertices as x, y pairs in drawing space. The last joins back to the first.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    }
  },
  "required": [
    "points",
    "color"
  ],
  "type": "object"
}
stroke object

One pen stroke, drawn in order, rendered as a variable-width outline of its input points (as perfect-freehand does).

Properties

color string Required

A CSS hex color, or one of the document theme's colors: primary (text), accent, or tertiary (faded text).

points array of integer Required

Flattened input points as x, y, pressure triples: x and y in drawing space, pressure from 0 to 1000.

simulatePressure boolean Optional

The input had no real pressure (a mouse or finger); derive it from the stroke's speed instead.

size integer Required

The stroke's base diameter in drawing space.

minimum: 1
View raw schema
{
  "description": "One pen stroke, drawn in order, rendered as a variable-width outline of its input points (as perfect-freehand does).",
  "properties": {
    "color": {
      "description": "A CSS hex color, or one of the document theme's colors: primary (text), accent, or tertiary (faded text).",
      "type": "string"
    },
    "points": {
      "description": "Flattened input points as x, y, pressure triples: x and y in drawing space, pressure from 0 to 1000.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "simulatePressure": {
      "description": "The input had no real pressure (a mouse or finger); derive it from the stroke's speed instead.",
      "type": "boolean"
    },
    "size": {
      "description": "The stroke's base diameter in drawing space.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "points",
    "color",
    "size"
  ],
  "type": "object"
}
viewBox object

No description available.

Properties

height integer Required

No description available.

minimum: 1
width integer Required

No description available.

minimum: 1
x integer Required

No description available.

y integer Required

No description available.

View raw schema
{
  "properties": {
    "height": {
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "minimum": 1,
      "type": "integer"
    },
    "x": {
      "type": "integer"
    },
    "y": {
      "type": "integer"
    }
  },
  "required": [
    "x",
    "y",
    "width",
    "height"
  ],
  "type": "object"
}

Lexicon Garden

@