GH-Elements

Icon Element

Icon is a gh-element that allows to add icon in any part of the application. You can use it as you see fit. It has the simplest settings.

Functional Characteristics

The icon element is usually used in the settings of elements such as filter tabs and view tab, paired with color. But it can also be used to customize elements in your application.

Value Format

This element takes the name of the icon as the value.

{
    "field_value": "box"
}

There are lots of different icons available for using in this element.

Element Options

All icon options are limited to field settings. In turn, icon field settings has only standard options like Field Name and Name Space:

Settings of icon field

Element Style

The icon element has one of the simplest list of interpretation types and a standard set of style settings with a single difference.

Style of icon element

General Settings

Unlike previous group of settings, element style has one additional option.

General settings of icon style

Name Description
Image Type allow to change the icon format

Image Type

This option is a special option that is used mostly in development. It allows to change the format of icon. There are two types of format:

  • SVG
  • Canvas

Image type is useful when the icon element is used in other platforms. Then you can select the needed format. Also, canvas is useful for documents which will be converts in PDF format.

Data Model

The icon have no extra properties in data model besides interpretation array.

{
    "data_model": {
        "interpretation": []
    }
}
Name Type Description
interpretation array contains all icon interpretations

Filtration

This element cannot be filtered out.

Interpretation

The icon element has the two interpretation types.

Types of icon interpretation

Default

The first type is default. It is the selected blue icon in 40x40 px size.

Value

The second interpretation type displays the value of the current field.