Class StockIcon

A utility class that helps working with icons.

Hierarchy

FrameworkObject
- StockIcon

Index

Constructors

Methods

getDefaultStyle getEmoji getFont getIcon getIconInPoints makeString

Constructors

`Protected`constructor

new StockIcon(isInternalConstructor?): StockIcon
Parameters
- OptionalisInternalConstructor: boolean
Returns StockIcon
Overrides FrameworkObject.constructor

Methods

`Static`getDefaultStyle

getDefaultStyle(icon): EnumValue<StockIconStyle, number>
Returns the default suggested StockIcon style for the icon.
Parameters
- icon: EnumValue<StockIconType, number>
Returns EnumValue<StockIconStyle, number>

`Static`getEmoji

getEmoji(emojiCode): Image
Returns an Image that represents the given Emoji. The code is the UTF32 representation of the emoji.
Parameters
- emojiCode: number
Returns Image

`Static`getFont

getFont(style): Font
Returns the builtin font icon for the given style.
Parameters
- style: EnumValue<StockIconStyle, number>
Returns Font

`Static`getIcon

getIcon(options): Image
Returns a Image for the at the requested in pixels. Uses the default style for the icon.
Parameters
- options: {
      icon: EnumValue<StockIconType, number>;
      size?: number;
  } | {
      icon: EnumValue<StockIconType, number>;
      size?: number;
      style: EnumValue<StockIconStyle, number>;
  }
  Options object for the function call.
Returns Image

`Static`getIconInPoints

getIconInPoints(options): Image
Returns a Image for the at the requested in points. Uses the default style for the icon.
Parameters
- options: {
      icon: EnumValue<StockIconType, number>;
      size?: number;
  } | {
      icon: EnumValue<StockIconType, number>;
      size?: number;
      style: EnumValue<StockIconStyle, number>;
  }
  Options object for the function call.
Returns Image

`Static`makeString

makeString(icon): string
Makes a string that contains the given font awesome unicode code.
Parameters
- icon: EnumValue<StockIconType, number>
Returns string