Liking cljdoc? Tell your friends :D

org.soulspace.overarch.domain.view

Functions for the definition and handling of views.

Functions for the definition and handling of views.
raw docstring

boundary-predclj

(boundary-pred model view config)

Returns a predicate function to check if an element should be transformed to a boundary as specified in the config for the view

Returns a predicate function to check if an element should be transformed to a boundary
as specified in the `config` for the `view`
sourceraw docstring

element->boundaryclj

Maps model types to boundary types depending on the view type.

Maps model types to boundary types depending on the view type.
sourceraw docstring

element-to-rendercljmultimethod

Returns the model element to be rendered for element e for the view in the context of the model. Maps some elements to other elements (e.g. boundaries), depending on the type of view.

Returns the model element to be rendered for element `e` for the `view` in the context of the `model`.
Maps some elements to other elements (e.g. boundaries), depending on the type of view.
sourceraw docstring

element-to-render_clj

(element-to-render_ model view config e)

Returns the element to render in the view for the given element e in the context of the model. Transforms a node to a boundary, if necessary.

Returns the element to render in the `view` for the given element `e` in the context of the `model`.
Transforms a node to a boundary, if necessary.
sourceraw docstring

elements-to-renderclj

(elements-to-render model view)
(elements-to-render model view coll)

Returns the list of elements to render in the view or the given coll of elements, depending on the type of the view.

Returns the list of elements to render in the `view` or the given `coll` of
elements, depending on the type of the view.
sourceraw docstring

expand-external-specclj

(expand-external-spec view)

Returns the expand external specification for the view.

Returns the expand external specification for the `view`.
sourceraw docstring

graphviz-specclj

(graphviz-spec view)

Returns the graphviz specification for the view.

Returns the graphviz specification for the `view`.
sourceraw docstring

hierarchical?clj

(hierarchical? view config)
source

include-content?cljmultimethod

Returns true if the content of element e is rendered in the view in the context of the model.

Returns true if the content of element `e` is rendered in the `view` in the context of the `model`.
sourceraw docstring

include-specclj

(include-spec view)

Returns the include specification for the view. Defaults to :referenced-only.

Returns the include specification for the `view`. Defaults to :referenced-only.
sourceraw docstring

included-elementsclj

(included-elements model view specified)

Returns the model elements specified and included for the view, e.g. related nodes or relations.

Returns the `model` elements specified and included for the view,
e.g. related nodes or relations.
sourceraw docstring

layout-specclj

(layout-spec view)

Returns the layout specification for the view. Defaults to :top-down.

Returns the layout specification for the `view`. Defaults to :top-down.
sourceraw docstring

legend-specclj

(legend-spec view)

Returns the legend specification for the view. Defaults to true.

Returns the legend specification for the `view`. Defaults to true.
sourceraw docstring

linetype-specclj

(linetype-spec view)

Returns the linetype specification for the view.

Returns the linetype specification for the `view`.
sourceraw docstring

node-predclj

(node-pred model view config)

Returns a predicate function to check if a node should be rendered as specified in the config for the view

Returns a predicate function to check if a node should be rendered
as specified in the `config` for the `view`
sourceraw docstring

plantuml-specclj

(plantuml-spec view)

Returns the plantuml specification for the view.

Returns the plantuml specification for the `view`.
sourceraw docstring

referenced-elementsclj

(referenced-elements model view)

Returns the model elements explicitly referenced in the given view.

Returns the `model` elements explicitly referenced in the given `view`.
sourceraw docstring

relation-predclj

(relation-pred model view config)

Returns a predicate function to check if a node should be rendered as specified in the config for the view

Returns a predicate function to check if a node should be rendered
as specified in the `config` for the `view`
sourceraw docstring

render-model-element?cljmultimethod

Returns true if the element e is rendered in the view in the context of the model.

Returns true if the element `e` is rendered in the `view` in the context of the `model`.
sourceraw docstring

rendered-elementsclj

(rendered-elements model view)
(rendered-elements model view coll)

Returns the elements to render in the view for the given model.

Returns the elements to render in the `view` for the given `model`.
sourceraw docstring

root-elementsclj

(root-elements model elements)

Returns the root elements for a collection of model elements, e.g. to start the rendering of a hierarchical view with.

Returns the root elements for a collection of `model` `elements`,
e.g. to start the rendering of a hierarchical view with.
sourceraw docstring

selected-elementsclj

(selected-elements model view)

Returns the model elements selected by criteria for the view.

Returns the `model` elements selected by criteria for the `view`.
sourceraw docstring

selection-specclj

(selection-spec view)

Returns the selection specification for the view.

Returns the selection specification for the `view`.
sourceraw docstring

sketch-specclj

(sketch-spec view)

Returns the sketch specification for the view. Defaults to false.

Returns the sketch specification for the `view`. Defaults to false.
sourceraw docstring

specified-elementsclj

(specified-elements model view)

Returns the model elements specified for the view, either as refs or as selection.

Returns the `model` elements specified for the view,
either as refs or as selection.
sourceraw docstring

styles-specclj

(styles-spec model view)

Returns the styles specification for the model and the view.

Returns the styles specification for the `model` and the `view`.
sourceraw docstring

themes->stylesclj

(themes->styles model view)

Returns the vector of styles from the themes of the given view.

Returns the vector of styles from the themes of the given `view`.
sourceraw docstring

themes-specclj

(themes-spec view)

Returns the themes specification for the view.

Returns the themes specification for the `view`.
sourceraw docstring

titleclj

(title v)

Returns the title of the view v, uses the name, if no title is set.

Returns the title of the view `v`, uses the name, if no title is set.
sourceraw docstring

view-configclj

source

view-elementsclj

(view-elements model view)

Returns the model elements specified for the given view.

Returns the `model` elements specified for the given `view`.
sourceraw docstring

view-typeclj

(view-type view)
(view-type model view)
(view-type model view & _)

Returns the type of the view.

Returns the type of the `view`.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close