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 full)

Properties

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

Properties

Optional circle

circle?: boolean

Draw the icon inside a circle.

Optional filled

filled?: boolean

Draw the enclosing shape as a solid shape.

Optional flipX

flipX?: boolean

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

Optional flipY

flipY?: boolean

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

Optional monospaced

monospaced?: boolean

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

Optional moveX

moveX?: number

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

Optional moveY

moveY?: number

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

Optional preserveAspect

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.

Optional preserveColor

preserveColor?: boolean

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

Optional rotate

rotate?: number

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

Optional scale

scale?: number

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

Optional search

search?: boolean

Draw the icon inside a magnifying glass shape.

Optional square

square?: boolean

Draw the icon inside a square.

Optional strike

strike?: boolean

Draw a strike-through line over the icon.

Settings

Member Visibility

Theme

On This Page

circlefilledflipXflipYmonospacedmoveXmoveYpreserveAspectpreserveColorrotatescalesearchsquarestrike