Access
Family Circles primarily consists of 3 applications: viewer, builder, and explorer. It also has an admin application for managing a service that can be used by the builder and is required for the explorer.
The applications can be accessed from this site by clicking on these icons any place you see them
or through your own URL, page Link, or Embedded in a page.
URL
The applications can be run using URL's like:
http://fc.jenika.com/code/<version>/<application>?<args>
Example
http://fc.jenika.com/code/current/viewer?data=/data/family.json
<version>
Use any directory name found in /code.
<application>
Application | Description |
---|---|
viewer | Interact with static model |
builder | Interact/build model and view/modify data in a service |
explorer | Interact with model and view data in a service |
admin | Load/Export/Monitor/Clear service |
<args>
The applications support the following arguments:
Application | Argument | Value | Description |
---|---|---|---|
viewer | data | URL | URL to a Family Circles JSON Data file |
builder | service (optional) | URL | URL of Family Circles service |
explorer | service | URL | URL of Family Circles service |
admin | service (optional) | URL | URL of Family Circles service |
Link
So you can create a specific link to the viewer like:
<a href="http://fc.jenika.com/code/current/viewer?data=/data/family-a.json">Family</a>
Example: Family
Embedding
The easiest way to render a model on a page is to use an iframe.
<iframe src="http://fc.jenika.com/code/<version>/<application>?<args>" width="200px" height="200px" frameborder="0" style="border:0"></iframe>
Example:
<iframe src="http://fc.jenika.com//code/current/viewer?data=/data/family-a.json" width="200px" height="200px" frameborder="0" style="border:0"></iframe>
Result:
Any of the applications can be embedded on a page using the same approach as above.