@gooddata/gooddata-js/lib/catalogue.d.ts

GoodData JavaScript SDK

import { XhrModule } from "./xhr";
import { ExecutionModule } from "./execution";
import { ItemDescription } from "./interfaces";
export declare class CatalogueModule {
    private xhr;
    private execution;
    constructor(xhr: XhrModule, execution: ExecutionModule);
    loadItems(projectId: string, options?: {}): Promise<any>;
    loadDateDataSets(projectId: string, options: any): Promise<any>;
    /**
     * Loads item description objects and returns them
     *
     * @internal
     * @private
     *
     * @param projectId {string}
     * @param mdObj metadata object containing buckets, visualization class, properties etc.
     * @param attributesMap contains map of attributes where the keys are the attributes display forms URIs
     * @param removeDateItems {boolean} skip date items
     * @return ItemDescription which is either `{ uri: string }` or `{ expression: string }`
     */
    loadItemDescriptionObjects(projectId: string, mdObj: any, attributesMap: any, removeDateItems?: boolean): Promise<ItemDescription[]>;
    /**
     * ItemDescription is either URI or MAQL expression
     * https://github.com/gooddata/gdc-bear/blob/185.4/resources/specification/md/obj.res#L284
     *
     * @param projectId {string}
     * @param mdObj metadata object containing buckets, visualization class, properties etc.
     * @param attributesMap contains map of attributes where the keys are the attributes display forms URIs
     * @param removeDateItems {boolean} skip date items
     * @deprecated
     */
    loadItemDescriptions(projectId: string, mdObj: any, attributesMap: any, removeDateItems?: boolean): Promise<string[]>;
    private requestDateDataSets;
    private loadCatalog;
}