Interface CanvasEffectsContainerProperties

Optional Widget constructor properties.

interface CanvasEffectsContainerProperties {
    accentFill?: FillStyle;
    backgroundFill?: FillStyle;
    backgroundGlowFill?: FillStyle;
    blinkRate?: number;
    bodyTextAlign?: number;
    bodyTextFill?: FillStyle;
    bodyTextFont?: string;
    bodyTextHeight?: null | number;
    bodyTextSpacing?: null | number;
    canvasFill?: FillStyle;
    checkboxInnerPadding?: number;
    checkboxLength?: number;
    compositeOperation?: GlobalCompositeOperation;
    containerAlignment?: Alignment2D;
    containerPadding?: Padding;
    cursorIndicatorSize?: number;
    cursorThickness?: number;
    enabled?: boolean;
    filter?: string;
    flex?: number;
    flexBasis?: null | number;
    flexShrink?: number;
    id?: null | string;
    inputBackgroundFill?: FillStyle;
    inputSelectBackgroundFill?: FillStyle;
    inputTextAlign?: number;
    inputTextFill?: FillStyle;
    inputTextFillDisabled?: FillStyle;
    inputTextFillInvalid?: FillStyle;
    inputTextFont?: string;
    inputTextHeight?: null | number;
    inputTextInnerPadding?: Padding;
    inputTextMinWidth?: number;
    inputTextSpacing?: null | number;
    maxHeight?: number;
    maxWidth?: number;
    mediaFallbackFill?: FillStyle;
    minHeight?: number;
    minWidth?: number;
    multiContainerAlignment?: FlexAlignment2D;
    multiContainerSpacing?: number;
    opacity?: number;
    primaryFill?: FillStyle;
    radioButtonInnerPadding?: number;
    radioButtonLength?: number;
    roundedCornersRadii?: CornerRadii;
    scrollbarCornersRadii?: CornerRadii;
    scrollBarMinPercent?: number;
    scrollBarMinPixels?: number;
    scrollbarPadding?: Padding;
    scrollBarThickness?: number;
    sliderMinLength?: number;
    sliderThickness?: number;
    tooltipFill?: FillStyle;
    tooltipPadding?: Padding;
    tooltipRadii?: CornerRadii;
}

Hierarchy (view full)

Properties

accentFill? backgroundFill? backgroundGlowFill? blinkRate? bodyTextAlign? bodyTextFill? bodyTextFont? bodyTextHeight? bodyTextSpacing? canvasFill? checkboxInnerPadding? checkboxLength? compositeOperation? containerAlignment? containerPadding? cursorIndicatorSize? cursorThickness? enabled? filter? flex? flexBasis? flexShrink? id? inputBackgroundFill? inputSelectBackgroundFill? inputTextAlign? inputTextFill? inputTextFillDisabled? inputTextFillInvalid? inputTextFont? inputTextHeight? inputTextInnerPadding? inputTextMinWidth? inputTextSpacing? maxHeight? maxWidth? mediaFallbackFill? minHeight? minWidth? multiContainerAlignment? multiContainerSpacing? opacity? primaryFill? radioButtonInnerPadding? radioButtonLength? roundedCornersRadii? scrollbarCornersRadii? scrollBarMinPercent? scrollBarMinPixels? scrollbarPadding? scrollBarThickness? sliderMinLength? sliderThickness? tooltipFill? tooltipPadding? tooltipRadii?

Properties

OptionalaccentFill

accentFill?: FillStyle

The accent fill style. Usually a saturated colour more saturated than ThemeProperties#primaryFill used for highlighting boxes which use PrimaryFill.

OptionalbackgroundFill

backgroundFill?: FillStyle

The background fill style. Used for widgets with a background (as in, a background above the canvas background).

OptionalbackgroundGlowFill

backgroundGlowFill?: FillStyle

The background glow fill style. Used for highlighting boxes which use ThemeProperties#backgroundFill.

OptionalblinkRate

blinkRate?: number

The blink rate of text cursors in text input widgets like TextInput. Value in "blinks" per second.

OptionalbodyTextAlign

bodyTextAlign?: number

The default text alignment mode of body text (most regular text).

OptionalbodyTextFill

bodyTextFill?: FillStyle

The fill style used for body text (most regular text).

OptionalbodyTextFont

bodyTextFont?: string

The font style used for body text (most regular text).

OptionalbodyTextHeight

bodyTextHeight?: null | number

The height of each line of text in body text (most regular text). If null, it will be automatically detected.

OptionalbodyTextSpacing

bodyTextSpacing?: null | number

The spacing between each line of text in body text (most regular text). If null, it will be automatically detected.

OptionalcanvasFill

canvasFill?: FillStyle

The canvas background fill style.

OptionalcheckboxInnerPadding

checkboxInnerPadding?: number

The Padding used for Checkbox between the accent box shown when ticked and the background box.

OptionalcheckboxLength

checkboxLength?: number

The length in pixels used for Checkbox.

OptionalcompositeOperation

compositeOperation?: GlobalCompositeOperation

Sets CanvasEffectsContainer#compositeOperation.

OptionalcontainerAlignment

containerAlignment?: Alignment2D

The alignment in Container for when there is extra space.

OptionalcontainerPadding

containerPadding?: Padding

The Padding used in Container.

OptionalcursorIndicatorSize

cursorIndicatorSize?: number

The side length of a text cursor's indicator in pixels. For now there is only a tab mode indicator.

OptionalcursorThickness

cursorThickness?: number

The thickness of a text cursor in pixels.

Optionalenabled

enabled?: boolean

Sets Widget#enabled.

Optionalfilter

filter?: string

Sets CanvasEffectsContainer#filter.

Optionalflex

flex?: number

Sets Widget#flex.

OptionalflexBasis

flexBasis?: null | number

Sets Widget#flexBasis.

OptionalflexShrink

flexShrink?: number

Sets Widget#flexShrink.

Optionalid

id?: null | string

Sets Widget#id.

OptionalinputBackgroundFill

inputBackgroundFill?: FillStyle

The background fill style used for input widgets like TextInput.

OptionalinputSelectBackgroundFill

inputSelectBackgroundFill?: FillStyle

The background fill style used for input widgets like TextInput when text is selected.

OptionalinputTextAlign

inputTextAlign?: number

The default text alignment mode of text input widgets like TextInput.

OptionalinputTextFill

inputTextFill?: FillStyle

The fill style used for text in input widgets like TextInput.

OptionalinputTextFillDisabled

inputTextFillDisabled?: FillStyle

The fill style used for text in input widgets like TextInput when disabled.

OptionalinputTextFillInvalid

inputTextFillInvalid?: FillStyle

The fill style used for text in input widgets like TextInput when invalid.

OptionalinputTextFont

inputTextFont?: string

The font style used for text in input widgets like TextInput.

OptionalinputTextHeight

inputTextHeight?: null | number

The height of each line of text in input widgets like TextInput. If null, it will be automatically detected.

OptionalinputTextInnerPadding

inputTextInnerPadding?: Padding

The Padding between text and border used for text input widgets like TextInput.

OptionalinputTextMinWidth

inputTextMinWidth?: number

The default minimum width of text input widgets like TextInput.

OptionalinputTextSpacing

inputTextSpacing?: null | number

The spacing between each line of text in input widgets like TextInput. If null, it will be automatically detected.

OptionalmaxHeight

maxHeight?: number

Sets Widget#maxHeight.

OptionalmaxWidth

maxWidth?: number

Sets Widget#maxWidth.

OptionalmediaFallbackFill

mediaFallbackFill?: FillStyle

The fill style to use when media fails to load.

OptionalminHeight

minHeight?: number

Sets Widget#minHeight.

OptionalminWidth

minWidth?: number

Sets Widget#minWidth.

OptionalmultiContainerAlignment

multiContainerAlignment?: FlexAlignment2D

The alignment in MultiContainer for when there is unused space.

OptionalmultiContainerSpacing

multiContainerSpacing?: number

The spacing length between widgets in MultiContainer.

Optionalopacity

opacity?: number

Sets CanvasEffectsContainer#opacity.

OptionalprimaryFill

primaryFill?: FillStyle

The primary fill style. Usually a saturated colour used for filling boxes that need to stand out.

OptionalradioButtonInnerPadding

radioButtonInnerPadding?: number

Similar to ThemeProperties#checkboxInnerPadding, but for RadioButton.

OptionalradioButtonLength

radioButtonLength?: number

Similar to ThemeProperties#checkboxLength, but for RadioButton.

OptionalroundedCornersRadii

roundedCornersRadii?: CornerRadii

The radii to be used for rounding corners in RoundedCorners.

OptionalscrollbarCornersRadii

scrollbarCornersRadii?: CornerRadii

The radii to be used for rounding corners in ScrollableViewportWidget scrollbars.

OptionalscrollBarMinPercent

scrollBarMinPercent?: number

The minimum length of the filled part of a ScrollableViewportWidget's scrollbar in percentage of total length.

OptionalscrollBarMinPixels

scrollBarMinPixels?: number

The minimum length of the filled part of a ScrollableViewportWidget's scrollbar in pixels.

OptionalscrollbarPadding

scrollbarPadding?: Padding

The Padding used in ScrollableViewportWidget scrollbars.

OptionalscrollBarThickness

scrollBarThickness?: number

The thickness of a ScrollableViewportWidget's scrollbar in pixels.

OptionalsliderMinLength

sliderMinLength?: number

The minimum length of a Slider

OptionalsliderThickness

sliderThickness?: number

The thickness of a Slider

OptionaltooltipFill

tooltipFill?: FillStyle

The fill style to paint a TooltipContainer's background with.

OptionaltooltipPadding

tooltipPadding?: Padding

The Padding used in TooltipContainer.

OptionaltooltipRadii

tooltipRadii?: CornerRadii

The radii to be used for rounding corners in TooltipContainer.

Settings

Member Visibility

On This Page

Properties
accentFillbackgroundFillbackgroundGlowFillblinkRatebodyTextAlignbodyTextFillbodyTextFontbodyTextHeightbodyTextSpacingcanvasFillcheckboxInnerPaddingcheckboxLengthcompositeOperationcontainerAlignmentcontainerPaddingcursorIndicatorSizecursorThicknessenabledfilterflexflexBasisflexShrinkidinputBackgroundFillinputSelectBackgroundFillinputTextAligninputTextFillinputTextFillDisabledinputTextFillInvalidinputTextFontinputTextHeightinputTextInnerPaddinginputTextMinWidthinputTextSpacingmaxHeightmaxWidthmediaFallbackFillminHeightminWidthmultiContainerAlignmentmultiContainerSpacingopacityprimaryFillradioButtonInnerPaddingradioButtonLengthroundedCornersRadiiscrollbarCornersRadiiscrollBarMinPercentscrollBarMinPixelsscrollbarPaddingscrollBarThicknesssliderMinLengthsliderThicknesstooltipFilltooltipPaddingtooltipRadii