pptx-automizer/dist/types/modify-types.d.ts

A template based pptx generator

import { XmlElement } from './xml-types';
export type ModifyCallback = {
    (element: XmlElement): any;
};
export type ModifyCollectionCallback = {
    (collection: HTMLCollectionOf<XmlElement>): any;
};
/**
 * A Modification is applied to xml elements by ModificationTags.
 * Specify an index if not 0 and put one or more ModifyCallbacks to
 * 'modify' prop.
 */
export type Modification = {
    index?: number;
    last?: boolean;
    all?: boolean;
    collection?: ModifyCollectionCallback;
    children?: ModificationTags;
    modify?: ModifyCallback | ModifyCallback[];
    create?: any;
    isRequired?: boolean;
    fromPrevious?: boolean;
    fromIndex?: number;
    forceCreate?: boolean;
};
/**
 * ModificationTags will specify the target xml tags for your
 * modifications. ModificationTags can be nested by using 'children'.
 */
export type ModificationTags = {
    [tag: string]: Modification;
};
export type Color = {
    type?: 'schemeClr' | 'srgbClr';
    value: string;
    shade?: string | number;
    tint?: string | number;
};
export type Border = {
    tag: 'lnL' | 'lnR' | 'lnT' | 'lnB';
    type?: 'solid' | 'sysDot' | string;
    weight?: number;
    color?: Color;
};
export type HyperlinkInfo = {
    target: string | number;
    isInternal?: boolean;
};
export type TextStyle = {
    size?: number;
    color?: Color;
    isBold?: boolean;
    isItalics?: boolean;
    isUnderlined?: boolean;
    isSuperscript?: boolean;
    isSubscript?: boolean;
    hyperlink?: HyperlinkInfo;
};
export type ImageStyle = {
    duotone?: {
        color?: Color;
        prstClr?: string;
        tint?: number;
        satMod?: number;
    };
};
export type ReplaceText = {
    replace: string;
    by: ReplaceTextReplacement | ReplaceTextReplacement[];
};
export type ReplaceTextReplacement = {
    text: string;
    style?: TextStyle;
};
export type ReplaceTextOptions = {
    openingTag: string;
    closingTag: string;
};