Olympe SDK

Namespace: common

olympe.ui. common

Members

<static, readonly> AspectRatioMode :string

Type:
  • string
Properties:
Name Type Default Description
FILL string fill
CONTAIN string contain
COVER string cover

<static> BackgroundImagePosition :string

Background image positions

Type:
  • string
Properties:
Name Type Default Description
MANUAL string manual
TOPLEFT string topleft
TOP string top
TOPRIGHT string topright
CENTERLEFT string centerleft
CENTER string center
CENTERRIGHT string centerright
BOTTOMLEFT string bottomleft
BOTTOM string bottom
BOTTOMRIGHT string bottomright

<static> BackgroundImageSize :string

Background image sizing modes

Type:
  • string
Properties:
Name Type Default Description
AUTO string auto
MANUAL string manual
CONTAIN string contain
COVER string cover

<static, readonly> BlendMode :string

Type:
  • string
Properties:
Name Type Default Description
NORMAL string normal
MULTIPLY string multiply
SCREEN string screen
DARKEN string darken
LIGHTEN string lighten
SRCIN string srcin
SRCOUT string srcout
SRCATOP string srcatop
XOR string xor

<static, readonly> FilterInput :string

Type:
  • string
Properties:
Name Type Default Description
SOURCE_GRAPHIC string source_graphic
SOURCE_ALPHA string source_alpha
BACKGROUND_IMAGE string background_image
BACKGROUND_ALPHA string background_alpha
FILL_PAINT string fill_paint
STROKE_PAINT string stroke_paint

<static, readonly> FontStyle :string

Type:
  • string
Properties:
Name Type Default Description
NORMAL string normal
ITALIC string italic
OBLIQUE string oblique

<static, readonly> GrowMode :string

Type:
  • string
Properties:
Name Type Default Description
MANUAL string manual

Follows the dimension set on the UI layer
AUTO_WIDTH string auto_width

Width will grow with content UI layer
AUTO_HEIGHT string auto_height

Height will grow with content UI layer
AUTO_WIDTH_HEIGHT string auto_width_height

Width and Height will grow with content UI layer
SMART_WIDTH string smart_width

Follows the dimension set on the UI layer but if content width is smaller than layer width, layer will follow content width
SMART_HEIGHT string smart_height

Follows the dimension set on the UI layer but if content heigth is smaller than layer heigth, layer will follow content heigth
SMART_WIDTH_HEIGHT string smart_width_height

Follows the dimension set on the UI layer but if content width/heigth is smaller than layer width/heigth, layer will follow content width/heigth

<static, readonly> HorizontalAlign :string

Type:
  • string
Properties:
Name Type Default Description
LEFT string left
CENTER string center
RIGHT string right

<static, readonly> InputDeviceType :string

Type:
  • string
Properties:
Name Type Default Description
DEFAULTAUDIO string defaultaudio
DEFAULTVIDEO string defaultvideo
FACINGVIDEO string facingvideo
ENVIRONMENTVIDEO string environmentvideo

<static, readonly> LineCapMode :string

Type:
  • string
Properties:
Name Type Default Description
BUTT string butt
ROUND string round
SQUARE string square

<static, readonly> LineJoinMode :string

Type:
  • string
Properties:
Name Type Default Description
BEVEL string bevel
ROUND string round
MITER string miter

<static, readonly> Orientation :string

Type:
  • string
Properties:
Name Type Default Description
PORTRAIT string portrait
LANDSCAPE string landscape

<static, readonly> TextFieldCapitalization :string

Enum for different capizalization of text field values

Type:
  • string
Properties:
Name Type Default Description
NONE string none
CHARACTERS string characters
WORDS string words
SENTENCES string sentences

<static, readonly> TextFieldType :string

Enum for different types of text field values

Type:
  • string
Properties:
Name Type Default Description
TEXT string text
PASSWORD string password
EMAIL string email
PHONE string phone
NUMBER string number

<static, readonly> TextOverflow :string

Type:
  • string
Properties:
Name Type Default Description
CLIP string clip
ELLIPSIS string ellipsis
FADE string fade

<static, readonly> VerticalAlign :string

Type:
  • string
Properties:
Name Type Default Description
TOP string top
MIDDLE string middle
BOTTOM string bottom