PopClip JavaScript API Reference
    Preparing search index...

    Interface IconProperties

    Properties that define how an icon is interpreted.

    interface IconProperties {
        circle?: boolean;
        filled?: boolean;
        flipX?: boolean;
        flipY?: boolean;
        monospaced?: boolean;
        moveX?: number;
        moveY?: number;
        preserveAspect?: boolean;
        preserveColor?: boolean;
        rotate?: number;
        scale?: number;
        search?: boolean;
        square?: boolean;
        strike?: boolean;
    }

    Hierarchy (View Summary)

    Index
    circle? filled? flipX? flipY? monospaced? moveX? moveY? preserveAspect? preserveColor? rotate? scale? search? square? strike?
    circle?: boolean

    Draw the icon inside a circle.

    filled?: boolean

    Draw the enclosing shape as a solid shape.

    flipX?: boolean

    If true, the supplied icon will be drawn horizontally flipped. Default is false.

    flipY?: boolean

    If true, the supplied icon will be drawn vertically flipped. Default is false.

    monospaced?: boolean

    For text icons only. Draw the text using a monospaced font.

    moveX?: number

    Move the icon horizontally by the specified distance, expressed as percentage of the icon's width.

    moveY?: number

    Move the icon vertically by the specified distance, expressed as percentage of the icon's height.

    preserveAspect?: boolean

    If true, the supplied icon will be displayed with its original aspect ratio instead of being scaled to fit a square. Default is false.

    preserveColor?: boolean

    If true, the supplied icon will be displayed with its original color instead of being filled in white/black. Default is false.

    rotate?: number

    Rotate the icon anticlockwise by the specified angle, expressed in degrees.

    scale?: number

    Scale the icon by the specified factor, expressed as a percentage of the original size.

    search?: boolean

    Draw the icon inside a magnifying glass shape.

    square?: boolean

    Draw the icon inside a square.

    strike?: boolean

    Draw a strike-through line over the icon.

    Settings
    Member Visibility

    On This Page
    Properties