Liking cljdoc? Tell your friends :D

scicloj.kindly.v4.kind

Kinds for visualization

Kinds for visualization
raw docstring

codeclj/s

(code)
(code value)
(code value options)

display-as: the code only, not the result example: (+ 1 2) hide-code: true

display-as: the code only, not the result
example: (+ 1 2)
hide-code: true
raw docstring

cytoscapeclj/s

(cytoscape)
(cytoscape value)
(cytoscape value options)

display-as: a graph example: {:nodes #{1 4 3 2 5}, :edges #{[4 3] [4 2] [1 2] [3 5]}} docs: https://js.cytoscape.org/#notation/elements-json json-schema: https://raw.githubusercontent.com/AZaitzeff/cytoscape_js_schema/main/cytoscape_schema.json

display-as: a graph
example: {:nodes #{1 4 3 2 5}, :edges #{[4 3] [4 2] [1 2] [3 5]}}
docs: https://js.cytoscape.org/#notation/elements-json
json-schema: https://raw.githubusercontent.com/AZaitzeff/cytoscape_js_schema/main/cytoscape_schema.json
raw docstring

datasetclj/s

(dataset)
(dataset value)
(dataset value options)

display-as: a table example: (->> (System/getProperties) (map (fn [[k v]] {:k k, :v (apply str (take 40 (str v)))})) (tech.v3.dataset/->>dataset {:dataset-name "My Truncated System Properties"})) docs: https://github.com/techascent/tech.ml.dataset

display-as: a table
example: (->> (System/getProperties) (map (fn [[k v]] {:k k, :v (apply str (take 40 (str v)))})) (tech.v3.dataset/->>dataset {:dataset-name "My Truncated System Properties"}))
docs: https://github.com/techascent/tech.ml.dataset
raw docstring

echartsclj/s

(echarts)
(echarts value)
(echarts value options)

display-as: a chart example: [["a" "b" "c" "d"] [1 2 3 4]] docs: https://echarts.apache.org/en/option.html

display-as: a chart
example: [["a" "b" "c" "d"] [1 2 3 4]]
docs: https://echarts.apache.org/en/option.html
raw docstring

hiccupclj/s

(hiccup)
(hiccup value)
(hiccup value options)

display-as: HTML example: [:div [:h3 "Hello " [:em "World"]]]

display-as: HTML
example: [:div [:h3 "Hello " [:em "World"]]]
raw docstring

hiddenclj/s

(hidden)
(hidden value)
(hidden value options)

display-as: do not display example: ["SECRET"]

display-as: do not display
example: ["SECRET"]
raw docstring

htmlclj/s

(html)
(html value)
(html value options)

display-as: HTML example: <div><h3>Hello ><em>World</em></h3><div>

display-as: HTML
example: <div><h3>Hello ><em>World</em></h3><div>
raw docstring

imageclj/s

(image)
(image value)
(image value options)
display-as: an image
example: https://raw.githubusercontent.com/scicloj/graphic-design/live/icons/Kindly.svg
raw docstring

mapclj/s

(map)
(map value)
(map value options)

display-as: associated values example: {:key1 "value1", :key2 "value2"}

display-as: associated values
example: {:key1 "value1", :key2 "value2"}
raw docstring

mdclj/s

(md)
(md value)
(md value options)

display-as: a Markdown string example: ## Hello World hide-code: true

display-as: a Markdown string
example: ## Hello *World*
hide-code: true
raw docstring

plotlyclj/s

(plotly)
(plotly value)
(plotly value options)

display-as: a plot example: [{:x [1 2 3 4 5], :y [1 2 4 8 16]}] docs: https://plotly.com/javascript/getting-started/ json-schema: https://plotly.com/chart-studio-help/json-chart-schema/

display-as: a plot
example: [{:x [1 2 3 4 5], :y [1 2 4 8 16]}]
docs: https://plotly.com/javascript/getting-started/
json-schema: https://plotly.com/chart-studio-help/json-chart-schema/
raw docstring

portalclj/s

(portal)
(portal value)
(portal value options)

display-as: portal example: {:key1 "value1", :key2 [:div [:h3 "Hello " [:em "World"]]]}

display-as: portal
example: {:key1 "value1", :key2 [:div [:h3 "Hello " [:em "World"]]]}
raw docstring

pprintclj/s

(pprint)
(pprint value)
(pprint value options)

display-as: a formatted string example: {:key1 "value1", :key2 "value2"}

display-as: a formatted string
example: {:key1 "value1", :key2 "value2"}
raw docstring

reagentclj/s

(reagent)
(reagent value)
(reagent value options)

display-as: A reagent component inside HTML example: [(fn [] [:button {:on-click (fn [ev] (js/alert "You pressed it"))} "Press me"])]

display-as: A reagent component inside HTML
example: [(fn [] [:button {:on-click (fn [ev] (js/alert "You pressed it"))} "Press me"])]
raw docstring

seqclj/s

(seq)
(seq value)
(seq value options)

display-as: a sequence example: (range 5)

display-as: a sequence
example: (range 5)
raw docstring

setclj/s

(set)
(set value)
(set value options)

display-as: a bag example: (set (range 5))

display-as: a bag
example: (set (range 5))
raw docstring

tableclj/s

(table)
(table value)
(table value options)

display-as: a table example: {:headers [:a], :rows [{:a 1} {:a 2}]}

display-as: a table
example: {:headers [:a], :rows [{:a 1} {:a 2}]}
raw docstring

testclj/s

(test)
(test value)
(test value options)

display-as: success or failure example: (deftest unity-test (is (= 1 1)))

display-as: success or failure
example: (deftest unity-test (is (= 1 1)))
raw docstring

varclj/s

(var)
(var value)
(var value options)

display-as: the name of a var example: (def testvar 100)

display-as: the name of a var
example: (def testvar 100)
raw docstring

vectorclj/s

(vector)
(vector value)
(vector value options)

display-as: a sequence example: (vec (range 5))

display-as: a sequence
example: (vec (range 5))
raw docstring

vegaclj/s

(vega)
(vega value)
(vega value options)

display-as: a chart example: {:description "A basic bar chart example, with value labels shown upon pointer hover.", :axes [{:orient "bottom", :scale "xscale"} {:orient "left", :scale "yscale"}], :width 400, :scales [{:name "xscale", :type "band", :domain {:data "table", :field "category"}, :range "width", :padding 0.05, :round true} {:name "yscale", :domain {:data "table", :field "amount"}, :nice true, :range "height"}], :padding 5, :marks [{:type "rect", :from {:data "table"}, :encode {:enter {:x {:scale "xscale", :field "category"}, :width {:scale "xscale", :band 1}, :y {:scale "yscale", :field "amount"}, :y2 {:scale "yscale", :value 0}}, :update {:fill {:value "steelblue"}}, :hover {:fill {:value "red"}}}} {:type "text", :encode {:enter {:align {:value "center"}, :baseline {:value "bottom"}, :fill {:value "#333"}}, :update {:x {:scale "xscale", :signal "tooltip.category", :band 0.5}, :y {:scale "yscale", :signal "tooltip.amount", :offset -2}, :text {:signal "tooltip.amount"}, :fillOpacity [{:test "datum === tooltip", :value 0} {:value 1}]}}}], :signals [{:name "tooltip", :value {}, :on [{:events "rect:pointerover", :update "datum"} {:events "rect:pointerout", :update "{}"}]}], :height 200, :data [{:name "table", :values [{:category "A", :amount 28} {:category "B", :amount 55} {:category "C", :amount 43} {:category "D", :amount 91} {:category "E", :amount 81} {:category "F", :amount 53} {:category "G", :amount 19} {:category "H", :amount 87}]}]} docs: https://vega.github.io/vega/docs/ json-schema: https://vega.github.io/schema/vega/v5.json

display-as: a chart
example: {:description "A basic bar chart example, with value labels shown upon pointer hover.", :axes [{:orient "bottom", :scale "xscale"} {:orient "left", :scale "yscale"}], :width 400, :scales [{:name "xscale", :type "band", :domain {:data "table", :field "category"}, :range "width", :padding 0.05, :round true} {:name "yscale", :domain {:data "table", :field "amount"}, :nice true, :range "height"}], :padding 5, :marks [{:type "rect", :from {:data "table"}, :encode {:enter {:x {:scale "xscale", :field "category"}, :width {:scale "xscale", :band 1}, :y {:scale "yscale", :field "amount"}, :y2 {:scale "yscale", :value 0}}, :update {:fill {:value "steelblue"}}, :hover {:fill {:value "red"}}}} {:type "text", :encode {:enter {:align {:value "center"}, :baseline {:value "bottom"}, :fill {:value "#333"}}, :update {:x {:scale "xscale", :signal "tooltip.category", :band 0.5}, :y {:scale "yscale", :signal "tooltip.amount", :offset -2}, :text {:signal "tooltip.amount"}, :fillOpacity [{:test "datum === tooltip", :value 0} {:value 1}]}}}], :signals [{:name "tooltip", :value {}, :on [{:events "rect:pointerover", :update "datum"} {:events "rect:pointerout", :update "{}"}]}], :height 200, :data [{:name "table", :values [{:category "A", :amount 28} {:category "B", :amount 55} {:category "C", :amount 43} {:category "D", :amount 91} {:category "E", :amount 81} {:category "F", :amount 53} {:category "G", :amount 19} {:category "H", :amount 87}]}]}
docs: https://vega.github.io/vega/docs/
json-schema: https://vega.github.io/schema/vega/v5.json
raw docstring

vega-liteclj/s

(vega-lite)
(vega-lite value)
(vega-lite value options)

display-as: VegaLite chart example: {:description "A simple bar chart with embedded data.", :data {:values [{"a" "A", "b" 28} {"a" "B", "b" 55} {"a" "C", "b" 43} {"a" "D", "b" 91} {"a" "E", "b" 81} {"a" "F", "b" 53} {"a" "G", "b" 19} {"a" "H", "b" 87} {"a" "I", "b" 52}]}, :mark "bar", :encoding {"x" {"field" "a", "type" "nominal", "axis" {"labelAngle" 0}}, "y" {"field" "b", "type" "quantitative"}}} docs: https://vega.github.io/vega-lite/docs/ json-schema: https://vega.github.io/schema/vega-lite/v5.json

display-as: VegaLite chart
example: {:description "A simple bar chart with embedded data.", :data {:values [{"a" "A", "b" 28} {"a" "B", "b" 55} {"a" "C", "b" 43} {"a" "D", "b" 91} {"a" "E", "b" 81} {"a" "F", "b" 53} {"a" "G", "b" 19} {"a" "H", "b" 87} {"a" "I", "b" 52}]}, :mark "bar", :encoding {"x" {"field" "a", "type" "nominal", "axis" {"labelAngle" 0}}, "y" {"field" "b", "type" "quantitative"}}}
docs: https://vega.github.io/vega-lite/docs/
json-schema: https://vega.github.io/schema/vega-lite/v5.json
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close