ellipsis-folders
v2.1.0
Published
Access your ellipsis drive folder.
Downloads
47
Maintainers
floydremmerswaalReadme
Ellipsis Drive Folder package
This package allows you to easily use Ellipsis Drive on your website.
Installing the folder package
All releases of this package are listed in the release list on github here. To install this library, simply find the latest .js file in there, and put it in the directory of your project.
Importing the package
This will be added later.
Using the package
Place folders.js in your project directory. Construct an EllipsisDrive object, passing an object as paramater containing the following properties:
- "div", an HTML element where the folder browser should be displayed in.
- "cb" (semi-optional), the callback function to be called when a layer is clicked. A default callback is provided, but please provide your own.
- "token" (optional), the (Ellipsis) api token to be used.
- "showRaster" (optional, default true), determines whether raster layers should be displayed.
- "showVector" (optional, default true), determines whether vector layers should be displayed.
- "searchIncludeFolders" (optional, default true), determines whether search results should include folders or not.
If no token is provided, the user will be prompted to log in. The user will be redirected to Ellipsis Drive, and, after succesfully loging in, will be returned to the current page.
An example of the package:
test.html
<html>
<head>
<script src="https://raw.githubusercontent.com/ellipsis-drive/folders-package/npm-support/build/ellipsis-folders.js"></script>
</head>
<body>
<div id="test"></div>
<script>
let cb = (layer) => {
console.log("Clicked on layer:");
console.log(layer);
};
let div = document.getElementById("test");
let myDrive = new EllipsisDrive({ div: div, cb: cb });
</script>
</body>
</html>