Class ScrollBarContents

スクロールバーで操作するコンテンツ

コンテンツのサイズを変更した場合"changed_contents_size"イベントをemitすると、スクロールバーが再描画される。

Hierarchy

EventEmitter<ScrollBarContentsEventType>
- ScrollBarContents

Index

Constructors

constructor

new ScrollBarContents(
    target: Container,
    mask: Graphics,
    container: Container,
): ScrollBarContents
コンストラクタ
Parameters
- target: Container
  スクロール操作を受けるコンテンツ
- mask: Graphics
  targetを切り抜くマスク
- container: Container
  targetおよびmaskを格納する親コンテナ
Returns ScrollBarContents
Overrides EventEmitter<ScrollBarContentsEventType>.constructor
- Defined in src/scrollBar/ScrollBarContents.ts:21

Properties

container

container: Container

targetおよびmaskを格納する親コンテナ

`Readonly`mask

mask: Graphics

`Readonly`target

target: Container

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends "changed_contents_size">(
    event: T,
    fn: (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
          T,
          "changed_contents_size",
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:45

dispose

dispose(): void
Returns void
- Defined in src/scrollBar/ScrollBarContents.ts:130

emit

emit<T extends "changed_contents_size">(
    event: T,
    ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
        T,
        "changed_contents_size",
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<T, "changed_contents_size">]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): "changed_contents_size"[]
Return an array listing the events for which the emitter has registered listeners.

Returns "changed_contents_size"[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:15

getDisplayRate

getDisplayRate(isHorizontal: boolean): number
コンテンツが表示領域にどれだけ表示されているかの比率を取得する。この比率は、スクロールバーボタンのスケールとなる。

例 : コンテンツサイズが200、表示領域が100なら0.5 コンテンツがすべて表示されているなら1.0
Parameters
- isHorizontal: boolean
Returns number
0.0 ~ 1.0
- Defined in src/scrollBar/ScrollBarContents.ts:119

getScrollPositionAsRate

getScrollPositionAsRate(isHorizontal: boolean): number
現状のスクロール位置を取得する。単位rate 0.0でコンテンツはTOP, 1.0でBOTTOMに位置している。
Parameters
- isHorizontal: boolean
Returns number
- Defined in src/scrollBar/ScrollBarContents.ts:65

listenerCount

listenerCount(event: "changed_contents_size"): number
Return the number of listeners listening to a given event.
Parameters
- event: "changed_contents_size"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends "changed_contents_size">(
    event: T,
): (
    (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:20

off

off<T extends "changed_contents_size">(
    event: T,
    fn?: (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
          T,
          "changed_contents_size",
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:69

on

on<T extends "changed_contents_size">(
    event: T,
    fn: (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
          T,
          "changed_contents_size",
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:40

once

once<T extends "changed_contents_size">(
    event: T,
    fn: (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
          T,
          "changed_contents_size",
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "changed_contents_size"): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "changed_contents_size"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends "changed_contents_size">(
    event: T,
    fn?: (
        ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
            T,
            "changed_contents_size",
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "changed_contents_size"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
          T,
          "changed_contents_size",
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/pixi.js/node_modules/eventemitter3/index.d.ts:63

scroll

scroll(rate: number, isHorizontal: boolean): void
コンテンツを、指定されたrateの位置までスクロールする
Parameters
- rate: number
- isHorizontal: boolean
Returns void
- Defined in src/scrollBar/ScrollBarContents.ts:100

Class ScrollBarContents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ScrollBarContents

Properties

container

Readonlymask

Readonlytarget

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

dispose

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns "changed_contents_size"[]

getDisplayRate

Parameters

Returns number

getScrollPositionAsRate

Parameters

Returns number

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<ScrollBarContentsEventType>[Extract< T, "changed_contents_size", >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

scroll

Parameters

Returns void

Settings

On This Page

`Readonly`mask

`Readonly`target

`Static`prefixed

Returns (
(
...args: ArgumentMap<ScrollBarContentsEventType>[Extract<
T,
"changed_contents_size",
>],
) => void
)[]