Zum Hauptinhalt springen

API

constructor​

new FolderCounter(options: FolderCounterOptions): FolderCounter

Beispiel:

context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const gadget = new FolderCounter({
    title: "Meine Ordner",
    folders: [{
        id: "1234",
        name: "key",
        label: "Eingang",
        size: 10
    }]
});
context.returnValue = gadget.transfer();

Erweitertes Beispiel:

context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const gadget = new FolderCounter({
    id: "my-id",
    title: "Meine Ordner",
    folders: [{
        id: "1234",
        name: "key",
        label: "Eingang",
        size: 10
    }],
    sumSizeFromSubfolder: true,
    collapsed: true,
    animateSize: false
});
context.returnValue = gadget.transfer();

Statische Funktionen​

fromContextFolder : FolderCounter​

Erstellt ein FolderCounter Gadget anhand des aktuellen Ordners ( context.folder ).

FolderCounter.fromContextFolder(options: FolderInstanceOptions = {}): FolderCounter
context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const gadget = FolderCounter.fromContextFolder();
context.returnValue = gadget.transfer();

Erweitertes Beispiel

context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const gadget = FolderCounter.fromContextFolder({
    animateSize: false
});
context.returnValue = gadget.transfer();

fromFolder : FolderCounter​

Erstellt ein FolderCounter Gadget anhand eines Ordners.

FolderCounter.fromFolder(folder: Folder, options: FolderInstanceOptions = {}): FolderCounter
context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const folder = context.getFoldersByName("MyCustomFolder").first();
const gadget = FolderCounter.fromFolder(folder);
context.returnValue = gadget.transfer();

fromFolders : FolderCounter​

Erstellt ein FolderCounter Gadget anhand eines Ordners.

FolderCounter.fromFolders(folderIterator: FolderIterator, options: FolderIteratorOptions = {}): FolderCounter
context.enableModules();
const { FolderCounter } = require("ou.sp.gadget.FolderCounter");

const folders = context.getFoldersByName("MyCustom*");
const gadget = FolderCounter.fromFolders(folders);
context.returnValue = gadget.transfer();