ScrollBarVisibility

Show usages

Enumeration used by the horizontalScrollBarPolicy and verticalScrollBarPolicy properties.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.view.ScrollBarVisibility

Constants

ALWAYS

: number

Always display the scroll bar.

Remarks

If it is not needed, i.e. if all content is already displaying, the scroll bar will remain visible but cannot be moved.

AS_NEEDED

: number

Display the scroll bar only when needed, i.e., if not all of the content fits into the viewport, and hide it otherwise.

Remarks

This is the default behavior in most desktop applications.

AS_NEEDED_DYNAMIC

: number

Display the scroll bar only when needed, and only if interacting with the scroll bar or if the viewport changed recently.

Remarks

The scroll bar can only become visible if not all content fits into the viewport. In this case, it becomes visible on viewport changes or if the user interacts with it. It fades out after a short delay if no viewport changes and no interaction occurred.

This option causes both scroll bars to share this behavior, even when setting it only for either horizontalScrollBarPolicy or verticalScrollBarPolicy. The respective other scrollbar will still retain the meaning of its visibility, so mixing AS_NEEDED_DYNAMIC with NEVER will work as expected, for example.

This option also causes the scrollbar to overlap the content and no longer take space away from it.

NEVER

: number

Never display the scroll bar, even if not all of the content fits into the viewport.

Static Methods

from

(value: ScrollBarVisibility) : ScrollBarVisibility

Converts the argument to ScrollBarVisibility.

Parameters

options - Object
A map of options to pass to the method.

value - ScrollBarVisibility: The value to convert to ScrollBarVisibility.

Returns

↪ScrollBarVisibility: Either value if it is already a ScrollBarVisibility or an appropriate converted value.