@jaspersoft/jv-tools/dist/index.d.ts

Tools for working with JasperReports Server's Visualize.js

import { InputControlProperties } from './src/input-controls';
export * from './src/input-controls';
export type { useVisualizeConfig } from './src/visualize/hooks/useVisualize.types';
export type Authentication = {
    url?: string;
    name?: string;
    password?: string;
    organization?: string | null;
    locale?: string;
    timezone?: string;
    token?: string;
    preAuth?: boolean;
    tokenName?: string;
    loginFn?: () => void;
    logoutFn?: () => void;
};
export type SearchType = "folder" | "dataType" | "jdbcDataSource" | "awsDataSource" | "jndiJdbcDataSource" | "virtualDataSource" | "customDataSource" | "beanDataSource" | "xmlaConnection" | "listOfValues" | "file" | "reportOptions" | "dashboard" | "adhocDataView" | "query" | "olapUnit" | "reportUnit" | "domainTopic" | "semanticLayerDataSource" | "secureMondrianConnection" | "mondrianXmlaDefinition" | "mondrianConnection" | "inputControl" | "legacyDashboard";
export type SearchSortTerm = "uri" | "label" | "description" | "type" | "creationDate" | "updateDate" | "accessTime" | "popularity";
export type ResourcesSearchResponseType = {
    creationDate: string;
    description: string;
    label: string;
    permissionMask: number;
    resourceType: SearchType;
    updateDate: string;
    uri: string;
    version: number;
};
export type ResourcesSearch = {
    server?: string;
    q?: string;
    folderUri?: string;
    types?: SearchType[];
    offset?: number;
    limit?: number;
    recursive?: boolean;
    sortBy?: SearchSortTerm;
    accessType?: "viewed" | "modified";
    showHiddenItems?: boolean;
    forceTotalCount?: boolean;
    success?: (resources: ResourcesSearchResponseType[]) => void;
    error?: (err: any) => void;
};
export type VisualizeFactoryConfig = {
    visualizePath: string;
    publicPath?: string;
    server: string;
    auth: Authentication;
};
export type VisualizeFactory = {
    (params: Omit<VisualizeFactoryConfig, "visualizePath">, success: (v: VisualizeClient) => void, error: (err: any) => void): void;
    noConflict(): VisualizeFactory;
};
interface Deferred {
    done: (callback: (res: any) => void) => Deferred;
    fail: (callback: (err: any) => void) => Deferred;
}
export type VisualizeGenericError = {
    errorCode: string;
    message: string;
    parameters: {
        [key: string]: string;
    }[];
};
export type DefaultJiveUi = {
    enabled?: boolean;
    floatingTableHeadersEnabled?: boolean;
    floatingCrosstabHeadersEnabled?: boolean;
};
export type LinkOptions = {
    beforeRender?: (links: any) => {};
    events?: object;
};
export type ChartOpts = {
    animation?: boolean;
    zoom?: false | "x" | "y" | "xy";
};
export type VisualizationConfig = {
    resource: string;
    container?: string;
    params?: object;
    pages?: string | number | object;
    scale?: number | "container" | "width" | "height";
    defaultJiveUi?: DefaultJiveUi;
    isolateDom?: boolean;
    linkOptions?: LinkOptions;
    ignorePagination?: boolean;
    reportContainerWidth?: number;
    configuration?: string | undefined;
    reportLocale?: string;
    reportTimeZone?: string;
    autoresize?: boolean;
    centerReport?: boolean;
    useReportZoom?: boolean;
    modalDialogs?: boolean;
    chart?: ChartOpts;
    loadingOverlay?: boolean;
    scrollToTop?: boolean;
    showAdhocChartTitle?: boolean;
    markupType?: string;
    extendedSearch?: boolean;
    success?: (data: InputControlProperties[]) => void;
    error?: (error: VisualizeGenericError) => void;
    events?: any;
};
export type DashboardReport = {
    chart?: ChartOpts;
    loadingOverlay?: boolean;
};
export type DashboardProperties = {
    server?: string;
    resource: string;
    container?: object | string;
    linkOptions?: LinkOptions;
    params?: object;
    report?: DashboardReport;
    events?: any;
};
export type AdhocView = {
    resource: string;
    server?: string;
    container?: object | string;
    autoresize?: boolean;
    canvas?: any;
    linkOptions?: LinkOptions;
    loadingOverlay?: boolean;
    visualizationChooser?: {
        enabled?: boolean;
    };
    showTitle?: boolean;
    allowDrilldown?: boolean;
    designerMode?: boolean;
    params?: any;
    events?: any;
};
export type AdhocViewDataset = {
    params?: {
        offset?: any;
        pageSize?: any;
    };
};
export interface VisualizeClient {
    resourcesSearch: (config: ResourcesSearch) => any;
    logout(): Deferred;
    report: (config: VisualizationConfig) => any;
    adhocView: (config: VisualizationConfig) => any;
    dashboard: (config: VisualizationConfig) => any;
    inputControls: (config: VisualizationConfig) => any;
    server?: string;
}
export { visualizejsLoader } from './src/visualize/VisualizejsProvider';
export type { VisualizejsProvider } from './src/visualize/VisualizejsProvider';