@sheetxl/sdk 0.8.0-beta.10 → 0.8.0-beta.12

package/types/src/text/richtext/IStyledFont.d.ts

@@ -1,330 +0,0 @@
-import { Properties as CSSProperties } from 'csstype';
-import { IColor } from '../../color';
-import { IFont } from '../../font';
-import { ICellStyle } from '../../style';
-/**
- * Represents a font with styling color.
- */
-export interface IStyledFont {
-    /**
-     * This can be set as a string using html values such as 'Arial 11pt' but will be resolved to a single font. Fallbacks and fontSize will be
-     * marshalled into their correct property.
-     *
-     * A font with a {@link IStyledFont.getScheme | scheme} of `major` or `minor` is a theme font and
-     * reports the theme's heading or body font; a font with no family of its own reports the theme
-     * body font.
-     */
-    getFamily(): string;
-    /**
-     * Naming a family clears the {@link IStyledFont.getScheme | scheme}, since a font that names its
-     * own family is no longer a theme font.
-     *
-     * @see {@link IStyledFont.getFamily}
-     */
-    setFamily(family: string | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * A list of fonts and their fallbacks. These can also be provided in the fontFamily attribute but will
-     * be normalized to here.
-     */
-    getFallbacks(): string[];
-    /**
-     * @see {@link IStyledFont.setFallbacks}
-     */
-    setFallbacks(fallbacks: string[] | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Font size is either a number in points or a string that can be converted such as '14px', '1.5em'.
-     */
-    getSize(): number;
-    /**
-     * @see {@link IStyledFont.setSize}
-     */
-    setSize(size: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The weight of the characters.
-     */
-    getWeight(): number;
-    /**
-     * @see {@link IStyledFont.setWeight}
-     */
-    setWeight(weight: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Convenience for {@link IStyledFont.getWeight}. Returns `true` when the weight is bold (> 400).
-     */
-    getBold(): boolean;
-    /**
-     * Convenience for {@link IStyledFont.setWeight}. Sets the weight to bold (`700`) when `true`,
-     * normal (`400`) when `false`, or clears the weight when `null`.
-     *
-     * @remarks
-     * There is no `bold` property - bold is a spelling of {@link IStyledFont.Properties.weight}.
-     * The equivalent update-object form is {@link IStyledFont.Modifiers.bold}, which is folded onto
-     * `weight` before it is stored.
-     *
-     * @see {@link IStyledFont.getBold}
-     */
-    setBold(bold: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * @default `IFont.Style.Normal`
-     */
-    getStyle(): IFont.Style;
-    /**
-     * @see {@link IStyledFont.setStyle}
-     */
-    setStyle(style: IFont.Style | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Convenience for {@link IStyledFont.getStyle}. Returns `true` when the style is italic.
-     */
-    getItalic(): boolean;
-    /**
-     * Convenience for {@link IStyledFont.setStyle}. Sets the style to italic (`IFont.Style.Italic`)
-     * when `true`, normal (`IFont.Style.Normal`) when `false`, or clears the style when `null`.
-     *
-     * @remarks
-     * There is no `italic` property - italic is a spelling of {@link IStyledFont.Properties.style}.
-     * The equivalent update-object form is {@link IStyledFont.Modifiers.italic}, which is folded onto
-     * `style` before it is stored.
-     *
-     * @see {@link IStyledFont.getItalic}
-     */
-    setItalic(italic: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The text color.
-     */
-    getColor(): IColor;
-    /**
-     * @see {@link IStyledFont.getColor}
-     */
-    setColor(color: IColor | string | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Adds or removes additional spacing between the characters.
-     */
-    getLetterSpacing(): number;
-    /**
-     * @see {@link IStyledFont.setLetterSpacing}
-     */
-    setLetterSpacing(letterSpacing: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Sets the underline style. If true defaults to single. If false or null defaults to none.
-     *
-     * @default `IFont.UnderlineStyle.None`
-     */
-    getUnderline(): IFont.UnderlineStyle;
-    /**
-     * @see {@link IStyledFont.setUnderline}
-     */
-    setUnderline(underline: IFont.UnderlineStyle | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The effect draws the text with a line through it.
-     */
-    getStrike(): boolean;
-    /**
-     * @see {@link IStyledFont.setStrike}
-     */
-    setStrike(strike: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The theme font this font refers to, if any. A `major` or `minor` scheme makes the font follow
-     * the theme's heading or body font, overriding {@link IStyledFont.getFamily | family}.
-     *
-     * @default `IFont.Scheme.None`
-     */
-    getScheme(): IFont.Scheme;
-    /**
-     * Setting `major` or `minor` clears the {@link IStyledFont.getFamily | family}, since a theme
-     * font resolves its own.
-     *
-     * @see {@link IStyledFont.getScheme}
-     */
-    setScheme(scheme: IFont.Scheme | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Returns the vertical alignment of the text within a text line.
-     *
-     * @remarks
-     * If the IFont.VerticalAlignment is superscript or subscript then the font size should also render smaller.
-     */
-    getVerticalAlignment(): IFont.VerticalAlignment;
-    /**
-     * @see {@link IStyledFont.setVerticalAlignment}
-     */
-    setVerticalAlignment(verticalAlignment: IFont.VerticalAlignment | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The effect draws a shadow around the text.
-     *
-     * @remarks
-     * Not rendered by Excel or SheetXL.
-     */
-    getShadow(): boolean;
-    /**
-     * @see {@link IStyledFont.setShadow}
-     */
-    setShadow(shadow: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The effect draws the text as an outline.
-     *
-     * @remarks
-     * Not rendered by Excel or SheetXL.
-     */
-    getOutline(): boolean;
-    /**
-     * @see {@link IStyledFont.setOutline}
-     */
-    setOutline(outline: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The effect extends or stretches out the text.
-     *
-     * @remarks
-     * Not rendered by Excel or SheetXL.
-     */
-    getExtend(): boolean;
-    /**
-     * @see {@link IStyledFont.setExtend}
-     */
-    setExtend(extend: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * The character set the font was authored against, or `null` when the font does not name one.
-     *
-     * @remarks
-     * Purely a font-substitution hint - see {@link IFont.Charset}. Cell text is Unicode either way,
-     * so this does not change what a cell contains or, when the named family is installed, how it
-     * renders.
-     */
-    getCharset(): IFont.Charset | null;
-    /**
-     * @see {@link IStyledFont.getCharset}
-     */
-    setCharset(charset: IFont.Charset | null, options?: ICellStyle.UpdateOptions): IStyledFont;
-    /**
-     * Returns `true` if the font is either a superscript or a subscript.
-     */
-    isSuperSub(): boolean;
-    /**
-     * Returns the size to scale the font for super/sub text.
-     */
-    getSuperSubScale(): number;
-    /**
-     * Returns the number of pixels to shift the font for super/sub text.
-     */
-    getSuperSubShift(): number;
-    /**
-     * Compare against another font to see if they will have the same font measure
-     * This is used to optimize updates by not re-calcing the width/height
-     *
-     * @param other The other style font
-     */
-    isEqualMeasure(other: IStyledFont): boolean;
-    /**
-     * Returns the font styles as a set of css string that are suitable for css.
-     *
-     * @remarks
-     * Not all fill styles will offer an exact css equivalent.
-     * Additionally due to the nature of css having different properties for the same logic value
-     * (for example color, backgroundColor)
-     */
-    toCSS(mode?: IColor.CSSMode, zoom?: number, ignoreNormal?: boolean): CSSProperties;
-    /**
-     * Serializes to a JSON object.
-     */
-    toJSON(): IStyledFont.JSON;
-    /**
-     * For runtime type checking.
-     */
-    readonly isIStyledFont: true;
-}
-/**
- * {@inheritDoc IStyledFont}
- * @see
- * ### **Interface**
- *
- * {@link IStyledFont}
- */
-export declare namespace IStyledFont {
-    /**
-     * The canonical, serializable shape of a font.
-     *
-     * @remarks
-     * This is the *stored* form and carries exactly one spelling per concept - there is no `bold`
-     * or `italic` property here, and no string/boolean shorthands. Update calls accept the more
-     * forgiving {@link IStyledFont.Modifiers}, which is normalized to this shape before it is stored.
-     */
-    interface Properties<C = IColor.Serializable> {
-        /** {@inheritDoc IStyledFont.getFamily} */
-        family?: string;
-        /** {@inheritDoc IStyledFont.getFallbacks} */
-        fallbacks?: string[];
-        /** {@inheritDoc IStyledFont.getSize} */
-        size?: number;
-        /**
-         * The numeric weight of the characters, `400` being normal and `700` bold.
-         *
-         * @see {@link IStyledFont.getWeight}
-         */
-        weight?: number;
-        /** {@inheritDoc IStyledFont.getStyle} */
-        style?: IFont.Style;
-        /** {@inheritDoc IStyledFont.getColor} */
-        color?: C;
-        /** {@inheritDoc IStyledFont.getLetterSpacing} */
-        letterSpacing?: number;
-        /** {@inheritDoc IStyledFont.getUnderline} */
-        underline?: IFont.UnderlineStyle;
-        /** {@inheritDoc IStyledFont.getStrike} */
-        strike?: boolean;
-        /** {@inheritDoc IStyledFont.getScheme} */
-        scheme?: IFont.Scheme;
-        /** {@inheritDoc IStyledFont.getVerticalAlignment} */
-        verticalAlign?: IFont.VerticalAlignment;
-        /** {@inheritDoc IStyledFont.getShadow} */
-        shadow?: boolean;
-        /** {@inheritDoc IStyledFont.getOutline} */
-        outline?: boolean;
-        /** {@inheritDoc IStyledFont.getExtend} */
-        extend?: boolean;
-        /** {@inheritDoc IStyledFont.getCharset} */
-        charset?: IFont.Charset;
-    }
-    /**
-     * The shape accepted by font updates - {@link IStyledFont.Properties} widened with shorthands
-     * and with convenience aliases for the properties that have a boolean spelling.
-     *
-     * @remarks
-     * Every key here is normalized onto a {@link IStyledFont.Properties} key before it is stored, so
-     * none of the widened forms survive into {@link IStyledFont.JSON}. An explicit canonical key wins
-     * when both it and its alias are supplied.
-     */
-    type Modifiers<C = IColor.Serializable> = Omit<Properties<C>, 'weight' | 'underline'> & {
-        /**
-         * The weight of the characters, either numeric (`400`, `700`) or a css keyword such as
-         * `'bold'` or `'lighter'`.
-         *
-         * @see {@link IStyledFont.getWeight}
-         */
-        weight?: number | string;
-        /**
-         * The underline style. `true` is shorthand for `IFont.UnderlineStyle.Single`; `false` and
-         * `null` for `IFont.UnderlineStyle.None`.
-         *
-         * @see {@link IStyledFont.getUnderline}
-         */
-        underline?: boolean | IFont.UnderlineStyle | null;
-        /**
-         * Alias for {@link IStyledFont.Properties.weight}. `true` sets bold (`700`), `false` normal
-         * (`400`), `null` clears it. Ignored when `weight` is also supplied.
-         *
-         * @see {@link IStyledFont.setBold}
-         */
-        bold?: boolean | null;
-        /**
-         * Alias for {@link IStyledFont.Properties.style}. `true` sets `IFont.Style.Italic`, `false`
-         * `IFont.Style.Normal`, `null` clears it. Ignored when `style` is also supplied.
-         *
-         * @see {@link IStyledFont.setItalic}
-         */
-        italic?: boolean | null;
-    };
-    /**
-     * Options for updating a font.
-     */
-    type Update<C = IColor.Serializable> = IStyledFont | Modifiers<C> | string | null;
-    interface JSON extends Properties<string> {
-    }
-}
-//# sourceMappingURL=IStyledFont.d.ts.map