linkml_renderer.style package

Submodules

linkml_renderer.style.model module

class linkml_renderer.style.model.Configuration(**data)

Bases: ConfiguredBaseModel

A configuration for rendering instances of a LinkML model

frameworks: Optional[List[HTMLFramework]]

include_diagrams: Optional[bool]

rules: Optional[List[RenderRule]]

class linkml_renderer.style.model.ConfiguredBaseModel(**data): Bases: WeakRefShimBaseModel

class linkml_renderer.style.model.HTMLFramework(value)

Bases: str, Enum

An enumeration.

Bootstrap = 'Bootstrap'

Tailwind = 'Tailwind'

class linkml_renderer.style.model.LineStyle(value)

Bases: str, Enum

An enumeration.

DASHED = 'DASHED'

DOTTED = 'DOTTED'

DOUBLE = 'DOUBLE'

SOLID = 'SOLID'

class linkml_renderer.style.model.RenderElementType(value)

Bases: str, Enum

An enumeration.

NO_ELEMENT = 'NO_ELEMENT'

TUPLE = 'TUPLE'

description_list = 'description_list'

h1 = 'h1'

h2 = 'h2'

h3 = 'h3'

heading = 'heading'

simple_list = 'simple_list'

table = 'table'

class linkml_renderer.style.model.RenderRule(**data)

Bases: ConfiguredBaseModel

A rule for rendering a particular element

applies_to_curies: Optional[List[str]]

applies_to_render_types: Optional[List[RenderType]]

applies_to_slots: Optional[List[str]]

fstring: Optional[str]

name: Optional[str]

render_as: Optional[RenderElementType]

template: Optional[str]

class linkml_renderer.style.model.RenderType(value)

Bases: str, Enum

An enumeration.

HTML = 'HTML'

MARKDOWN = 'MARKDOWN'

MERMAID = 'MERMAID'

class linkml_renderer.style.model.Shape(value)

Bases: str, Enum

An enumeration.

CIRCLE = 'CIRCLE'

DIAMOND = 'DIAMOND'

ROUNDED_SQUARE = 'ROUNDED_SQUARE'

SQUARE = 'SQUARE'

class linkml_renderer.style.model.WeakRefShimBaseModel(**data): Bases: BaseModel

linkml_renderer.style.style_engine module

class linkml_renderer.style.style_engine.StyleEngine(schemaview, configuration=<factory>)

Bases: object

A style engine computes which style elements should be applied to a particular element.

configuration: Configuration

configure_slot(slot_name, render_as, **kwargs)

Return type: None

configure_slots(slot_names, render_as, **kwargs)

Return type: None

description_slot(class_name)

Return type: Optional[SlotDefinitionName]

schemaview: SchemaView

slot_by_curie(class_name, curies)

Return type: Optional[SlotDefinitionName]

slot_render_as(slot_name)

Return type: Optional[RenderElementType]

title_slot(class_name)

Return type: Optional[SlotDefinitionName]

linkml_renderer.style package

Submodules

linkml_renderer.style.model module

linkml_renderer.style.style_engine module

Module contents