Liking cljdoc? Tell your friends :D

oz.core


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
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
sourceraw docstring

logcljs

(log a-thing)
source

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
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
sourceraw docstring

publish-plot!clj

(publish-plot! plot & opts)

Deprecated form of publish!

Deprecated form of `publish!`
sourceraw docstring

render-vegacljs

(render-vega spec elem)
source

render-vega-litecljs

(render-vega-lite spec elem)
source

start-plot-server!clj

source

v!clj

(v! spec
    &
    {:as opts
     :keys [data width height host port mode]
     :or {port (:port (clojure.core/deref server/web-server_) 10666)
          host "localhost"
          mode :vega-lite}})

Take a vega or vega-lite clojure map spec and POST it to an oz server running at :host and :port to be rendered.

Take a vega or vega-lite clojure map `spec` and POST it to an oz
server running at `:host` and `:port` to be rendered.
sourceraw docstring

vegacljs

(vega spec)

Reagent component that renders vega

Reagent component that renders vega
sourceraw docstring

vega-litecljs

(vega-lite spec)

Reagent component that renders vega-lite.

Reagent component that renders vega-lite.
sourceraw docstring

view!clj

(view! spec
       &
       {:keys [data 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.

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.
sourceraw docstring

view-speccljs

(view-spec spec)
source

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

× close