nbprint.config.core.Page¶
- pydantic model nbprint.config.core.Page[source]¶
Bases:
BaseModelShow JSON schema
{ "title": "Page", "type": "object", "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "default": "", "title": "Css", "type": "string" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "top": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "top_left": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "top_left_corner": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "top_right": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "top_right_corner": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "bottom": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "bottom_left": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "bottom_left_corner": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "bottom_right": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "bottom_right_corner": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "left": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "left_top": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "left_bottom": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "right": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "right_top": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "right_bottom": { "anyOf": [ { "$ref": "#/$defs/PageRegion" }, { "type": "null" } ], "default": null }, "counter_reset": { "default": false, "title": "Counter Reset", "type": "boolean" }, "counter_style": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Counter Style" }, "size": { "anyOf": [ { "$ref": "#/$defs/PageSize" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": "letter", "title": "Size" }, "orientation": { "anyOf": [ { "$ref": "#/$defs/PageOrientation" }, { "type": "null" } ], "default": "portrait" } }, "$defs": { "Border": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "right": { "anyOf": [ { "$ref": "#/$defs/BorderStyle" }, { "type": "null" } ], "default": null }, "left": { "anyOf": [ { "$ref": "#/$defs/BorderStyle" }, { "type": "null" } ], "default": null }, "top": { "anyOf": [ { "$ref": "#/$defs/BorderStyle" }, { "type": "null" } ], "default": null }, "bottom": { "anyOf": [ { "$ref": "#/$defs/BorderStyle" }, { "type": "null" } ], "default": null } }, "title": "Border", "type": "object" }, "BorderLineStyle": { "enum": [ "none", "hidden", "dotted", "dashed", "solid", "double", "groove", "ridge", "inset", "outset" ], "title": "BorderLineStyle", "type": "string" }, "BorderLineWidth": { "enum": [ "thin", "medium", "thick" ], "title": "BorderLineWidth", "type": "string" }, "BorderStyle": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "width": { "anyOf": [ { "$ref": "#/$defs/BorderLineWidth" }, { "type": "integer" } ], "title": "Width" }, "style": { "$ref": "#/$defs/BorderLineStyle" }, "color": { "format": "color", "title": "Color", "type": "string" } }, "required": [ "width", "style", "color" ], "title": "BorderStyle", "type": "object" }, "Element": { "enum": [ "div", "span", "p", "h1", "h2", "h3", "h4", "h5", "h6" ], "title": "Element", "type": "string" }, "Font": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "family": { "anyOf": [ { "$ref": "#/$defs/FontFamily" }, { "type": "string" }, { "type": "null" } ], "default": null, "title": "Family" }, "size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Size" }, "transform": { "anyOf": [ { "$ref": "#/$defs/TextTransform" }, { "type": "null" } ], "default": null }, "decoration": { "anyOf": [ { "$ref": "#/$defs/TextDecoration" }, { "type": "null" } ], "default": null }, "style": { "anyOf": [ { "$ref": "#/$defs/FontStyle" }, { "type": "null" } ], "default": null }, "weight": { "anyOf": [ { "$ref": "#/$defs/FontWeight" }, { "type": "null" } ], "default": null }, "color": { "anyOf": [ { "format": "color", "type": "string" }, { "type": "null" } ], "default": null, "title": "Color" } }, "title": "Font", "type": "object" }, "FontFamily": { "enum": [ "serif", "sans-serif", "monospace" ], "title": "FontFamily", "type": "string" }, "FontStyle": { "enum": [ "normal", "italic" ], "title": "FontStyle", "type": "string" }, "FontWeight": { "enum": [ "normal", "bold" ], "title": "FontWeight", "type": "string" }, "Margin": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "right": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Right" }, "left": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Left" }, "top": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Top" }, "bottom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Bottom" } }, "title": "Margin", "type": "object" }, "Padding": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "right": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Right" }, "left": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Left" }, "top": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Top" }, "bottom": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Bottom" } }, "title": "Padding", "type": "object" }, "PageOrientation": { "enum": [ "portrait", "landscape" ], "title": "PageOrientation", "type": "string" }, "PageRegion": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "page" }, "ignore": { "default": true, "title": "Ignore", "type": "boolean" }, "css": { "default": "", "title": "Css", "type": "string" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "content": { "anyOf": [ { "$ref": "#/$defs/PageRegionContent" }, { "type": "null" } ] }, "style": { "anyOf": [ { "$ref": "#/$defs/Style" }, { "type": "null" } ], "default": null } }, "title": "PageRegion", "type": "object" }, "PageRegionContent": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "page" }, "ignore": { "default": true, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "title": "Content" } }, "title": "PageRegionContent", "type": "object" }, "PageSize": { "enum": [ "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "A10", "B4", "B5", "letter", "legal", "ledger" ], "title": "PageSize", "type": "string" }, "PseudoClass": { "enum": [ "active", "checked", "disabled", "empty", "enabled", "first-child", "focus", "hover", "last-child", "visited" ], "title": "PseudoClass", "type": "string" }, "PseudoElement": { "enum": [ "after", "before", "first-letter", "first-line", "marker", "placeholder", "selection" ], "title": "PseudoElement", "type": "string" }, "Role": { "enum": [ "undefined", "configuration", "context", "outputs", "parameters", "content", "page", "layout" ], "title": "Role", "type": "string" }, "Scope": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "element": { "anyOf": [ { "$ref": "#/$defs/Element" }, { "type": "string" }, { "type": "null" } ], "default": "", "title": "Element" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "title": "Id" }, "selector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "", "title": "Selector" }, "pseudoclass": { "anyOf": [ { "$ref": "#/$defs/PseudoClass" }, { "type": "null" } ], "default": "" }, "pseudoelement": { "anyOf": [ { "$ref": "#/$defs/PseudoElement" }, { "type": "null" } ], "default": "" } }, "title": "Scope", "type": "object" }, "Spacing": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "important": { "default": false, "title": "Important", "type": "boolean" }, "padding": { "anyOf": [ { "$ref": "#/$defs/Padding" }, { "type": "null" } ], "default": null }, "margin": { "anyOf": [ { "$ref": "#/$defs/Margin" }, { "type": "null" } ], "default": null } }, "title": "Spacing", "type": "object" }, "Style": { "properties": { "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "role": { "$ref": "#/$defs/Role", "default": "undefined" }, "ignore": { "default": false, "title": "Ignore", "type": "boolean" }, "css": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Css" }, "esm": { "anyOf": [ { "type": "string" }, { "format": "path", "type": "string" }, { "type": "null" } ], "default": "", "title": "Esm" }, "classname": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": "", "title": "Classname" }, "attrs": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Attrs" }, "scope": { "anyOf": [ { "$ref": "#/$defs/Scope" }, { "type": "null" } ], "default": null }, "spacing": { "anyOf": [ { "$ref": "#/$defs/Spacing" }, { "type": "null" } ], "default": null }, "font": { "anyOf": [ { "$ref": "#/$defs/Font" }, { "type": "null" } ], "default": null }, "border": { "anyOf": [ { "$ref": "#/$defs/Border" }, { "type": "null" } ], "default": null } }, "title": "Style", "type": "object" }, "TextDecoration": { "enum": [ "none", "underline", "overline", "dotted", "wavy" ], "title": "TextDecoration", "type": "string" }, "TextTransform": { "enum": [ "capitalize", "lowercase", "uppercase" ], "title": "TextTransform", "type": "string" } } }
- field top: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field top_left: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field top_left_corner: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field top_right: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field top_right_corner: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field bottom: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field bottom_left: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field bottom_left_corner: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field bottom_right: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field bottom_right_corner: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field left: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field left_top: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field left_bottom: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field right: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field right_top: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field right_bottom: Annotated[PageRegion, SerializeAsAny()] | None = None¶
- field counter_reset: bool = False¶
- field counter_style: str | None = None¶
- field size: PageSize | tuple[float, float] | None = PageSize.letter¶
- field orientation: PageOrientation | None = PageOrientation.portrait¶
- field css: str = ''¶
- Page.convert_top_from_obj[source]
- Page.convert_top_left_from_obj[source]
- Page.convert_top_left_corner_from_obj[source]
- Page.convert_top_right_from_obj[source]
- Page.convert_top_right_corner_from_obj[source]
- Page.convert_bottom_from_obj[source]
- Page.convert_bottom_left_from_obj[source]
- Page.convert_bottom_left_corner_from_obj[source]
- Page.convert_bottom_right_from_obj[source]
- Page.convert_bottom_right_corner_from_obj[source]
- Page.convert_left_from_obj[source]
- Page.convert_left_top_from_obj[source]
- Page.convert_left_bottom_from_obj[source]
- Page.convert_right_from_obj[source]
- Page.convert_right_top_from_obj[source]
- Page.convert_right_bottom_from_obj[source]
- generate(metadata: dict, config: Configuration, parent: BaseModel, attr: str = 'page', **_) NotebookNode | list[NotebookNode] | None[source]¶
Generate a notebook node for this model. This will be called before the runtime of the notebook, use it for code generation.
Args:¶
metadata (dict): common cell metadata
Returns:¶
NotebookNode: the content of the notebook node