The clog-plotly Reference Manual

This is the clog-plotly Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:02:32 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 clog-plotly

New CLOG System

Author

<>

License

BSD

Version

0.0.0

Dependency

clog (system).

Source

clog-plotly.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 clog-plotly/clog-plotly.asd

Source

clog-plotly.asd.

Parent Component

clog-plotly (system).

ASDF Systems

clog-plotly.


3.1.2 clog-plotly/clog-plotly.lisp

Source

clog-plotly.asd.

Parent Component

clog-plotly (system).

Packages

clog-plotly.

Public Interface
Internals

3.1.3 clog-plotly/test-plotly.lisp

Dependency

clog-plotly.lisp (file).

Source

clog-plotly.asd.

Parent Component

clog-plotly (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 clog-plotly

Source

clog-plotly.lisp.

Use List
  • clog.
  • common-lisp.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: start-test ()
Package

clog-plotly.

Source

clog-plotly.lisp.


5.1.2 Generic functions

Generic Function: add-traces-plotly (clog-plotly-element json-update)

Add traces plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: add-traces-plotly ((obj clog-plotly-element) json-update)
Generic Function: animate-plotly (clog-plotly-element json-frame json-attributes)

Animate frames with attriutes

Package

clog-plotly.

Source

clog-plotly.lisp.

Generic Function: attach-clog-plotly (clog-plotly-element)

Initialize plugin

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: attach-clog-plotly ((obj clog-plotly-element))
Generic Function: create-clog-plotly-element (clog-obj &key hidden class html-id auto-place)

Create a new clog-plotly-element as child of CLOG-OBJ.

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: create-clog-plotly-element ((obj clog-obj) &key hidden class html-id auto-place)

Create control - used at design time and in code

Generic Function: create-clog-plotly-element-design (clog-obj &key hidden class html-id auto-place)

Create a new clog-plotly-element as child of CLOG-OBJ.

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: create-clog-plotly-element-design ((obj clog-obj) &key hidden class html-id auto-place)

Create control - used at design time and in code

Generic Function: delete-traces-plotly (clog-plotly-element json-update)

Delete traces plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: delete-traces-plotly ((obj clog-plotly-element) json-update)
Generic Function: download-image-plotly (clog-plotly-element json-properties)

Download as image

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: download-image-plotly ((obj clog-plotly-element) json-properties)
Generic Function: extend-traces-plotly (clog-plotly-element json-update)

Extend traces plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: extend-traces-plotly ((obj clog-plotly-element) json-update)
Generic Function: init-clog-plotly (clog-plotly-element)

Initialize libraries

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: init-clog-plotly ((obj clog-plotly-element))
Generic Function: move-traces-plotly (clog-plotly-element json-update)

Move traces plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: move-traces-plotly ((obj clog-plotly-element) json-update)
Generic Function: new-plot-plotly (clog-plotly-element json-data json-layout)

Plot with plotly json-data and json-layout

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: new-plot-plotly ((obj clog-plotly-element) json-data json-layout)
Generic Function: prepend-traces-plotly (clog-plotly-element json-update)

Prepend traces plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: prepend-traces-plotly ((obj clog-plotly-element) json-update)
Generic Function: purge-plotly (clog-plotly-element)

Remove plot

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: purge-plotly ((obj clog-plotly-element))
Generic Function: react-plotly (clog-plotly-element json-data json-layout)

Plot with plotly json-data and json-layout

Package

clog-plotly.

Source

clog-plotly.lisp.

Generic Function: relayout-plotly (clog-plotly-element json-update)

Relayout plotly with json-update

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: relayout-plotly ((obj clog-plotly-element) json-update)
Generic Function: restyle-plotly (clog-plotly-element json-update trace-indices)

Restyle plotly with json-update and trace-indices.

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: restyle-plotly ((obj clog-plotly-element) json-update trace-indices)
Generic Function: set-on-plotly-animated (clog-plotly-element handler)

Set handler for animated plotly event

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-animated ((obj clog-plotly-element) handler)
Generic Function: set-on-plotly-auto-size (clog-plotly-element handler)

Set handler for auto-size plotly event

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-auto-size ((obj clog-plotly-element) handler)
Generic Function: set-on-plotly-deselect (clog-plotly-element handler)

Set handler for deselect plotly event

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-deselect ((obj clog-plotly-element) handler)
Generic Function: set-on-plotly-redraw (clog-plotly-element handler)

Set handler for redraw plotly event

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-redraw ((obj clog-plotly-element) handler)
Generic Function: set-on-plotly-to-image (clog-plotly-element handler)

Set handler for receiving the image result of a call to to-image-plotly

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-to-image ((obj clog-plotly-element) handler)
Generic Function: to-image-plotly (clog-plotly-element json-properties)

Create plot using json-properties and fire the event on-plotlyto-image with string in url data form.

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: to-image-plotly ((obj clog-plotly-element) json-properties)
Generic Function: update-plotly (clog-plotly-element json-data json-plotly trace-indices)

An efficient means of updating both the data array and layout object in an existing plot.

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: update-plotly ((obj clog-plotly-element) json-data json-layout trace-indices)

5.2 Internals


5.2.1 Ordinary functions

Function: create-test-panel (clog-obj &key hidden class html-id auto-place)
Package

clog-plotly.

Source

test-plotly.lisp.

Function: on-test-clog-plotly (body)
Package

clog-plotly.

Source

clog-plotly.lisp.


5.2.2 Generic functions

Generic Function: animate-ploly (obj json-frame json-attributes)
Package

clog-plotly.

Methods
Method: animate-ploly ((obj clog-plotly-element) json-frame json-attributes)
Source

clog-plotly.lisp.

Generic Reader: button-3 (object)
Package

clog-plotly.

Methods
Reader Method: button-3 ((test-panel test-panel))

automatically generated reader method

Source

test-plotly.lisp.

Target Slot

button-3.

Generic Reader: button-4 (object)
Package

clog-plotly.

Methods
Reader Method: button-4 ((test-panel test-panel))

automatically generated reader method

Source

test-plotly.lisp.

Target Slot

button-4.

Generic Reader: clog-plotly-1 (object)
Package

clog-plotly.

Methods
Reader Method: clog-plotly-1 ((test-panel test-panel))

automatically generated reader method

Source

test-plotly.lisp.

Target Slot

clog-plotly-1.

Generic Function: react-ploly (obj json-data json-layout)
Package

clog-plotly.

Methods
Method: react-ploly ((obj clog-plotly-element) json-data json-layout)
Source

clog-plotly.lisp.

Generic Function: set-on-plotly-after-plot (clog-plotly-element handler)

Set handler for after-plot plotly event

Package

clog-plotly.

Source

clog-plotly.lisp.

Methods
Method: set-on-plotly-after-plot ((obj clog-plotly-element) handler)

5.2.3 Classes

Class: test-panel
Package

clog-plotly.

Source

test-plotly.lisp.

Direct superclasses

clog-panel.

Direct methods
Direct slots
Slot: button-4
Readers

button-4.

Writers

This slot is read-only.

Slot: button-3
Readers

button-3.

Writers

This slot is read-only.

Slot: clog-plotly-1
Readers

clog-plotly-1.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   B   C   D   E   F   G   I   M   N   O   P   R   S   T   U  
Index Entry  Section

A
add-traces-plotly: Public generic functions
add-traces-plotly: Public generic functions
animate-ploly: Private generic functions
animate-ploly: Private generic functions
animate-plotly: Public generic functions
attach-clog-plotly: Public generic functions
attach-clog-plotly: Public generic functions

B
button-3: Private generic functions
button-3: Private generic functions
button-4: Private generic functions
button-4: Private generic functions

C
clog-plotly-1: Private generic functions
clog-plotly-1: Private generic functions
create-clog-plotly-element: Public generic functions
create-clog-plotly-element: Public generic functions
create-clog-plotly-element-design: Public generic functions
create-clog-plotly-element-design: Public generic functions
create-test-panel: Private ordinary functions

D
delete-traces-plotly: Public generic functions
delete-traces-plotly: Public generic functions
download-image-plotly: Public generic functions
download-image-plotly: Public generic functions

E
extend-traces-plotly: Public generic functions
extend-traces-plotly: Public generic functions

F
Function, create-test-panel: Private ordinary functions
Function, on-test-clog-plotly: Private ordinary functions
Function, start-test: Public ordinary functions

G
Generic Function, add-traces-plotly: Public generic functions
Generic Function, animate-ploly: Private generic functions
Generic Function, animate-plotly: Public generic functions
Generic Function, attach-clog-plotly: Public generic functions
Generic Function, button-3: Private generic functions
Generic Function, button-4: Private generic functions
Generic Function, clog-plotly-1: Private generic functions
Generic Function, create-clog-plotly-element: Public generic functions
Generic Function, create-clog-plotly-element-design: Public generic functions
Generic Function, delete-traces-plotly: Public generic functions
Generic Function, download-image-plotly: Public generic functions
Generic Function, extend-traces-plotly: Public generic functions
Generic Function, init-clog-plotly: Public generic functions
Generic Function, move-traces-plotly: Public generic functions
Generic Function, new-plot-plotly: Public generic functions
Generic Function, prepend-traces-plotly: Public generic functions
Generic Function, purge-plotly: Public generic functions
Generic Function, react-ploly: Private generic functions
Generic Function, react-plotly: Public generic functions
Generic Function, relayout-plotly: Public generic functions
Generic Function, restyle-plotly: Public generic functions
Generic Function, set-on-plotly-after-plot: Private generic functions
Generic Function, set-on-plotly-animated: Public generic functions
Generic Function, set-on-plotly-auto-size: Public generic functions
Generic Function, set-on-plotly-deselect: Public generic functions
Generic Function, set-on-plotly-redraw: Public generic functions
Generic Function, set-on-plotly-to-image: Public generic functions
Generic Function, to-image-plotly: Public generic functions
Generic Function, update-plotly: Public generic functions

I
init-clog-plotly: Public generic functions
init-clog-plotly: Public generic functions

M
Method, add-traces-plotly: Public generic functions
Method, animate-ploly: Private generic functions
Method, attach-clog-plotly: Public generic functions
Method, button-3: Private generic functions
Method, button-4: Private generic functions
Method, clog-plotly-1: Private generic functions
Method, create-clog-plotly-element: Public generic functions
Method, create-clog-plotly-element-design: Public generic functions
Method, delete-traces-plotly: Public generic functions
Method, download-image-plotly: Public generic functions
Method, extend-traces-plotly: Public generic functions
Method, init-clog-plotly: Public generic functions
Method, move-traces-plotly: Public generic functions
Method, new-plot-plotly: Public generic functions
Method, prepend-traces-plotly: Public generic functions
Method, purge-plotly: Public generic functions
Method, react-ploly: Private generic functions
Method, relayout-plotly: Public generic functions
Method, restyle-plotly: Public generic functions
Method, set-on-plotly-after-plot: Private generic functions
Method, set-on-plotly-animated: Public generic functions
Method, set-on-plotly-auto-size: Public generic functions
Method, set-on-plotly-deselect: Public generic functions
Method, set-on-plotly-redraw: Public generic functions
Method, set-on-plotly-to-image: Public generic functions
Method, to-image-plotly: Public generic functions
Method, update-plotly: Public generic functions
move-traces-plotly: Public generic functions
move-traces-plotly: Public generic functions

N
new-plot-plotly: Public generic functions
new-plot-plotly: Public generic functions

O
on-test-clog-plotly: Private ordinary functions

P
prepend-traces-plotly: Public generic functions
prepend-traces-plotly: Public generic functions
purge-plotly: Public generic functions
purge-plotly: Public generic functions

R
react-ploly: Private generic functions
react-ploly: Private generic functions
react-plotly: Public generic functions
relayout-plotly: Public generic functions
relayout-plotly: Public generic functions
restyle-plotly: Public generic functions
restyle-plotly: Public generic functions

S
set-on-plotly-after-plot: Private generic functions
set-on-plotly-after-plot: Private generic functions
set-on-plotly-animated: Public generic functions
set-on-plotly-animated: Public generic functions
set-on-plotly-auto-size: Public generic functions
set-on-plotly-auto-size: Public generic functions
set-on-plotly-deselect: Public generic functions
set-on-plotly-deselect: Public generic functions
set-on-plotly-redraw: Public generic functions
set-on-plotly-redraw: Public generic functions
set-on-plotly-to-image: Public generic functions
set-on-plotly-to-image: Public generic functions
start-test: Public ordinary functions

T
to-image-plotly: Public generic functions
to-image-plotly: Public generic functions

U
update-plotly: Public generic functions
update-plotly: Public generic functions


A.3 Variables