The clog-collection Reference Manual

This is the clog-collection Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:48:59 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clog-collection

A set of CLOG Plugins

Author

Xu Jingtao <>

License

MIT

Version

0.1

Defsystem Dependency

literate-lisp (system).

Dependencies
  • iterate (system).
  • alexandria (system).
  • cl-ppcre (system).
  • clog (system).
  • yason (system).
Source

clog-collection.asd.

Child Component

base (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 clog-collection/base

Source

clog-collection.asd.

Parent Component

clog-collection (system).

Child Component

clog-collection.org (file).


4 Files

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


4.1 Lisp


4.1.1 clog-collection/clog-collection.asd

Source

clog-collection.asd.

Parent Component

clog-collection (system).

ASDF Systems

clog-collection.

Packages

clog-collection.system.


4.1.2 clog-collection/base/clog-collection.org

Source

clog-collection.asd.

Parent Component

base (module).

Packages

clog-collection.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 clog-collection

CLOG plugin for Cytoscaple.js

Source

clog-collection.org.

Use List
  • alexandria.
  • cl-ppcre.
  • clog.
  • clog-gui.
  • clog-web.
  • common-lisp.
  • iterate.
Public Interface
Internals

5.2 clog-collection.system

Source

clog-collection.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Reader: keymap-handler (instance)
Writer: (setf keymap-handler) (instance)
Package

clog-collection.

Source

clog-collection.org.

Target Slot

handler.

Reader: keymap-key (instance)
Writer: (setf keymap-key) (instance)
Package

clog-collection.

Source

clog-collection.org.

Target Slot

key.

Function: make-keymap (&key key handler return-value)
Package

clog-collection.

Source

clog-collection.org.


6.1.2 Generic functions

Generic Function: create-clog-codemirror (obj &key tab-size keymaps auto-completion extentions hidden class html-id auto-place)

Create a new clog-codemirror object in lisp.

Package

clog-collection.

Source

clog-collection.org.

Methods
Method: create-clog-codemirror ((obj clog-obj) &key tab-size keymaps auto-completion extentions hidden class html-id auto-place)

Create control - used at design time and in code

Generic Function: create-clog-cytoscape (obj &key elements style layout width height hidden class html-id auto-place)

Create a new clog-cytoscape object in lisp.

Package

clog-collection.

Source

clog-collection.org.

Methods
Method: create-clog-cytoscape ((obj clog-obj) &key elements style layout width height hidden class html-id auto-place)

Create control - used at design time and in code

Generic Function: create-clog-jsonview (obj &key json expand hidden class html-id auto-place)

Create a new clog-jsonview object in lisp.

Package

clog-collection.

Source

clog-collection.org.

Methods
Method: create-clog-jsonview ((obj clog-obj) &key json expand hidden class html-id auto-place)

Create control - used at design time and in code

Generic Function: js-id (clog-element)

Access to javascript object (private)

Package

clog-collection.

Source

clog-collection.org.

Methods
Method: js-id (clog-element)
Generic Function: keymap-event (keymap)

keymap event name

Package

clog-collection.

Source

clog-collection.org.

Methods
Method: keymap-event (keymap)

6.1.3 Standalone methods

Method: (setf text-value) ((obj clog-codemirror))
Package

clog.

Source

clog-collection.org.

Method: text-value ((obj clog-codemirror))
Package

clog.

Source

clog-collection.org.


6.2 Internals


6.2.1 Special variables

Special Variable: clog.js.codemirror.new
Package

clog-collection.

Source

clog-collection.org.

Special Variable: clog.js.jsonview.new
Package

clog-collection.

Source

clog-collection.org.


6.2.2 Ordinary functions

Function: ->json (obj)
Package

clog-collection.

Source

clog-collection.org.

Function: codemirror-demo1 (row)
Package

clog-collection.

Source

clog-collection.org.

Function: codemirror-demo1-auto-completion (json)
Package

clog-collection.

Source

clog-collection.org.

Function: copy-keymap (instance)
Package

clog-collection.

Source

clog-collection.org.

Function: cytoscape-demo1 (row)
Package

clog-collection.

Source

clog-collection.org.

Function: demo-page (body)
Package

clog-collection.

Source

clog-collection.org.

Function: jsonview-demo1 (row)
Package

clog-collection.

Source

clog-collection.org.

Function: keymap-p (object)
Package

clog-collection.

Source

clog-collection.org.

Reader: keymap-return-value (instance)
Writer: (setf keymap-return-value) (instance)
Package

clog-collection.

Source

clog-collection.org.

Target Slot

return-value.

Function: on-new-demo-window (body)
Package

clog-collection.

Source

clog-collection.org.

Function: plist->hash (&rest args)
Package

clog-collection.

Source

clog-collection.org.

Function: start-test ()
Package

clog-collection.

Source

clog-collection.org.


6.2.3 Generic functions

Generic Reader: cytoscape-elements (object)
Package

clog-collection.

Methods
Reader Method: cytoscape-elements ((clog-cytoscape clog-cytoscape))

automatically generated reader method

Source

clog-collection.org.

Target Slot

elements.

Generic Writer: (setf cytoscape-elements) (object)
Package

clog-collection.

Methods
Writer Method: (setf cytoscape-elements) ((clog-cytoscape clog-cytoscape))

automatically generated writer method

Source

clog-collection.org.

Target Slot

elements.

Generic Reader: cytoscape-language (object)
Package

clog-collection.

Methods
Reader Method: cytoscape-language ((clog-jsonview clog-jsonview))

automatically generated reader method

Source

clog-collection.org.

Target Slot

language.

Reader Method: cytoscape-language ((clog-codemirror clog-codemirror))

automatically generated reader method

Source

clog-collection.org.

Target Slot

language.

Generic Writer: (setf cytoscape-language) (object)
Package

clog-collection.

Methods
Writer Method: (setf cytoscape-language) ((clog-jsonview clog-jsonview))

automatically generated writer method

Source

clog-collection.org.

Target Slot

language.

Writer Method: (setf cytoscape-language) ((clog-codemirror clog-codemirror))

automatically generated writer method

Source

clog-collection.org.

Target Slot

language.

Generic Reader: cytoscape-layout (object)
Package

clog-collection.

Methods
Reader Method: cytoscape-layout ((clog-cytoscape clog-cytoscape))

automatically generated reader method

Source

clog-collection.org.

Target Slot

layout.

Generic Writer: (setf cytoscape-layout) (object)
Package

clog-collection.

Methods
Writer Method: (setf cytoscape-layout) ((clog-cytoscape clog-cytoscape))

automatically generated writer method

Source

clog-collection.org.

Target Slot

layout.

Generic Reader: cytoscape-style (object)
Package

clog-collection.

Methods
Reader Method: cytoscape-style ((clog-cytoscape clog-cytoscape))

automatically generated reader method

Source

clog-collection.org.

Target Slot

style.

Generic Writer: (setf cytoscape-style) (object)
Package

clog-collection.

Methods
Writer Method: (setf cytoscape-style) ((clog-cytoscape clog-cytoscape))

automatically generated writer method

Source

clog-collection.org.

Target Slot

style.

Generic Function: set-js-event (obj event handler)
Package

clog-collection.

Source

clog-collection.org.

Methods
Method: set-js-event (obj event handler)

6.2.4 Standalone methods

Method: bind-event-script ((obj clog-cytoscape) event-data call-back)
Package

clog.

Source

clog-collection.org.

Method: unbind-event-script ((obj clog-cytoscape) event-data)
Package

clog.

Source

clog-collection.org.


6.2.5 Structures

Structure: keymap
Package

clog-collection.

Source

clog-collection.org.

Direct superclasses

structure-object.

Direct slots
Slot: key
Type

string

Initform

(alexandria:required-argument "key")

Readers

keymap-key.

Writers

(setf keymap-key).

Slot: handler
Type

function

Initform

(alexandria:required-argument "handler")

Readers

keymap-handler.

Writers

(setf keymap-handler).

Slot: return-value
Package

clog.

Type

boolean

Readers

keymap-return-value.

Writers

(setf keymap-return-value).


6.2.6 Classes

Class: clog-codemirror

clog-codemirror Object.

Package

clog-collection.

Source

clog-collection.org.

Direct superclasses

clog-element.

Direct methods
Direct slots
Slot: language
Package

clog.

Initargs

:language

Readers

cytoscape-language.

Writers

(setf cytoscape-language).

Class: clog-cytoscape

clog-cytoscape Object.

Package

clog-collection.

Source

clog-collection.org.

Direct superclasses

clog-element.

Direct methods
Direct slots
Slot: elements
Initargs

:elements

Readers

cytoscape-elements.

Writers

(setf cytoscape-elements).

Slot: style
Package

clog.

Initargs

:style

Readers

cytoscape-style.

Writers

(setf cytoscape-style).

Slot: layout
Initargs

:layout

Readers

cytoscape-layout.

Writers

(setf cytoscape-layout).

Class: clog-jsonview

clog-jsonview Object.

Package

clog-collection.

Source

clog-collection.org.

Direct superclasses

clog-element.

Direct methods
Direct slots
Slot: language
Package

clog.

Initargs

:language

Readers

cytoscape-language.

Writers

(setf cytoscape-language).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   -  
B   C   D   F   G   J   K   M   O   P   S   T   U  
Index Entry  Section

(
(setf cytoscape-elements): Private generic functions
(setf cytoscape-elements): Private generic functions
(setf cytoscape-language): Private generic functions
(setf cytoscape-language): Private generic functions
(setf cytoscape-language): Private generic functions
(setf cytoscape-layout): Private generic functions
(setf cytoscape-layout): Private generic functions
(setf cytoscape-style): Private generic functions
(setf cytoscape-style): Private generic functions
(setf keymap-handler): Public ordinary functions
(setf keymap-key): Public ordinary functions
(setf keymap-return-value): Private ordinary functions
(setf text-value): Public standalone methods

-
->json: Private ordinary functions

B
bind-event-script: Private standalone methods

C
codemirror-demo1: Private ordinary functions
codemirror-demo1-auto-completion: Private ordinary functions
copy-keymap: Private ordinary functions
create-clog-codemirror: Public generic functions
create-clog-codemirror: Public generic functions
create-clog-cytoscape: Public generic functions
create-clog-cytoscape: Public generic functions
create-clog-jsonview: Public generic functions
create-clog-jsonview: Public generic functions
cytoscape-demo1: Private ordinary functions
cytoscape-elements: Private generic functions
cytoscape-elements: Private generic functions
cytoscape-language: Private generic functions
cytoscape-language: Private generic functions
cytoscape-language: Private generic functions
cytoscape-layout: Private generic functions
cytoscape-layout: Private generic functions
cytoscape-style: Private generic functions
cytoscape-style: Private generic functions

D
demo-page: Private ordinary functions

F
Function, (setf keymap-handler): Public ordinary functions
Function, (setf keymap-key): Public ordinary functions
Function, (setf keymap-return-value): Private ordinary functions
Function, ->json: Private ordinary functions
Function, codemirror-demo1: Private ordinary functions
Function, codemirror-demo1-auto-completion: Private ordinary functions
Function, copy-keymap: Private ordinary functions
Function, cytoscape-demo1: Private ordinary functions
Function, demo-page: Private ordinary functions
Function, jsonview-demo1: Private ordinary functions
Function, keymap-handler: Public ordinary functions
Function, keymap-key: Public ordinary functions
Function, keymap-p: Private ordinary functions
Function, keymap-return-value: Private ordinary functions
Function, make-keymap: Public ordinary functions
Function, on-new-demo-window: Private ordinary functions
Function, plist->hash: Private ordinary functions
Function, start-test: Private ordinary functions

G
Generic Function, (setf cytoscape-elements): Private generic functions
Generic Function, (setf cytoscape-language): Private generic functions
Generic Function, (setf cytoscape-layout): Private generic functions
Generic Function, (setf cytoscape-style): Private generic functions
Generic Function, create-clog-codemirror: Public generic functions
Generic Function, create-clog-cytoscape: Public generic functions
Generic Function, create-clog-jsonview: Public generic functions
Generic Function, cytoscape-elements: Private generic functions
Generic Function, cytoscape-language: Private generic functions
Generic Function, cytoscape-layout: Private generic functions
Generic Function, cytoscape-style: Private generic functions
Generic Function, js-id: Public generic functions
Generic Function, keymap-event: Public generic functions
Generic Function, set-js-event: Private generic functions

J
js-id: Public generic functions
js-id: Public generic functions
jsonview-demo1: Private ordinary functions

K
keymap-event: Public generic functions
keymap-event: Public generic functions
keymap-handler: Public ordinary functions
keymap-key: Public ordinary functions
keymap-p: Private ordinary functions
keymap-return-value: Private ordinary functions

M
make-keymap: Public ordinary functions
Method, (setf cytoscape-elements): Private generic functions
Method, (setf cytoscape-language): Private generic functions
Method, (setf cytoscape-language): Private generic functions
Method, (setf cytoscape-layout): Private generic functions
Method, (setf cytoscape-style): Private generic functions
Method, (setf text-value): Public standalone methods
Method, bind-event-script: Private standalone methods
Method, create-clog-codemirror: Public generic functions
Method, create-clog-cytoscape: Public generic functions
Method, create-clog-jsonview: Public generic functions
Method, cytoscape-elements: Private generic functions
Method, cytoscape-language: Private generic functions
Method, cytoscape-language: Private generic functions
Method, cytoscape-layout: Private generic functions
Method, cytoscape-style: Private generic functions
Method, js-id: Public generic functions
Method, keymap-event: Public generic functions
Method, set-js-event: Private generic functions
Method, text-value: Public standalone methods
Method, unbind-event-script: Private standalone methods

O
on-new-demo-window: Private ordinary functions

P
plist->hash: Private ordinary functions

S
set-js-event: Private generic functions
set-js-event: Private generic functions
start-test: Private ordinary functions

T
text-value: Public standalone methods

U
unbind-event-script: Private standalone methods