oz.core — metasoarous/oz 1.5.4

export! clj

(export! spec filepath & {:as opts :keys []})

In alpha; Export spec to an html file. May have other options, including svg, jpg & pdf available

gist! clj

(gist! spec & {:as opts :keys [name description public] :or {public false}})

Create a gist with the given spec.

Requires authentication, which must be provided by one of the following opts:

• :auth: a Github auth token the form "username:password"
• :auth-token: a GitHub OAuth1 / Personal access token as a string (recommended)
• for oauth2:
  • :client-id: an oauth2 client id property
  • :access-token: oauth2 access token

CAUTION: Note that running these options from the REPL may leave sensitive data in your ./.lein-repl-history file. Thus it's best that you avoid using these options, and instead create a single edn file at ~/.oz/github-creds.edn with these opts. You can run chmod 600 on it, so that only the owner is able to access it. If you want to specify a different path use:

• :auth-file: defaults to ~/.oz/github-creds.edn.

Additional options:

• :public: default false
• :description: auto generated based on spec

html clj

(html spec)

(html spec opts)

load clj

(load filename & {:as opts :keys [format]})

Reads file and processes according to file type

publish! clj

(publish! spec & {:as opts :keys [mode return-full-gist] :or {mode :vega-lite}})

Publish spec via gist! and print out the corresponding vega-editor or ozviz.io url.

Requires authentication, which must be provided by one of the following opts:

• :auth: a Github auth token the form "username:password"
• :oauth-token: a GitHub OAuth1 / Personal access token as a string (recommended)
• for oauth2:
  • :client-id: an oauth2 client id property
  • :access-token: oauth2 access token

CAUTION: Note that running these options from the REPL may leave sensitive data in your ./.lein-repl-history file. Thus it's best that you avoid using these options, and instead create a single edn file at ~/.oz/github-creds.edn with these opts. You can run chmod 600 on it, so that only the owner is able to access it. If you want to specify a different path use:

• :auth-file: defaults to ~/.oz/github-creds.edn.

Additional options:

• :public: default false
• :description: auto generated based on spec
• :return-full-gist: return the full tentacles gist api response data

render-vega cljs

(render-vega spec elem)

start-plot-server! clj

vega cljs

(vega spec)

Reagent component that renders vega

vega-lite cljs

(vega-lite spec)

Reagent component that renders vega-lite.

view! clj

(view! spec
       &
       {:keys [host port]
        :or {port (:port (clojure.core/deref server/web-server_) 10666)
             host "localhost"}})

More general view function which takes specs in hiccup form, where vega/vega-lite blocks can be passed as [:vega-lite plot-data] (e.g.), nested within arbitrary hiccup.