[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Inputman.GcTour

GcTour クラス

階層

  • GcTour

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • const gcTour = new GC.InputMan.GcTour({
    steps: [
        {
            target: gcTextBox,
            title: 'title',
            description: 'description',
        },
        {
            target: gcNumber,
            title: 'title',
            description: 'description',
        },
    ]
});

    引数

    戻り値 GcTour

プロパティ

読み取り専用 activeIndex

activeIndex: number

現在アクティブなステップのインデックスを取得します。アクティブなステップがない場合は -1 を返します。​​

autoFocusTarget

autoFocusTarget: boolean

現在のステップのターゲット要素に自動フォーカスするかどうかを取得または設定します。​​

closeOnEsc

closeOnEsc: boolean

ESC キーを押したときに GcTour を閉じるかどうかを取得または設定します。​​

closeOnOverlayClick

closeOnOverlayClick: boolean

空白領域をクリックしたときにGcTourを閉じるかどうかを取得または設定します

読み取り専用 componentName

componentName: string

コンポーネント名（'GcTour'）を取得します。

customTip

customTip: (context: TourCustomTipContext): void

カスタムチップのレンダリング関数を取得または設定します。

型宣言

disableInteraction

disableInteraction: boolean

ターゲット要素とのインタラクションを無効にするかどうかを取得または設定します。

hideDoneButton

hideDoneButton: boolean

最後のステップで「完了」ボタンを非表示にするかどうかを取得または設定します。

hidePreviousButton

hidePreviousButton: boolean

最初のステップで「前へ」ボタンを非表示にするかどうかを取得または設定します。

highlightRadius

highlightRadius: number

ハイライト領域の半径を取得または設定します。

読み取り専用 isActive

isActive: boolean

​​GcTour がアクティブかどうかを取得します。​​

読み取り専用 length

length: number

​​GcTour のステップ総数を取得します。​​

offset

offset: number | number[]

ハイライト領域とターゲット要素との相対的なオフセット量を取得または設定します。

showCloseButton

showCloseButton: boolean

閉じるボタンを表示するかどうかを取得または設定します。

showOverlay

showOverlay: boolean

モーダルで表示するかどうかを取得または設定します。

steps

steps: ITourStep[] | TourStepConfig[]

GcTour のステップ構成配列を取得または設定します。​

tipClassName

tipClassName: string

チップのCSSクラス名を取得または設定します。

tipDirection

tipDirection: TipDirection

チップの方向を取得または設定します。

tipPosition

tipPosition: TipPosition

チップの位置を取得または設定します。

tipResource

tipResource: TourTipResourceConfig

チップのリソース構成を取得または設定します。

メソッド

addEventListener

  • addEventListener(eventName: GcTourEvent, func: (sender: this, eventArgs?: object): void): void

  • 指定したイベントが発生したときに実行する処理を設定します。

    function stepChangedHandler(sender, args){
    console.log("Step Changed.");
}
gcTour.addEventListener(GC.InputMan.GcTourEvent.StepChanged, stepChangedHandler);

    引数

    • eventName: GcTourEvent

      イベントの種類を表す文字列（大文字と小文字を区別しません）

    • func: (sender: this, eventArgs?: object): void

      イベントが発生したときに実行する処理

        • (sender: this, eventArgs?: object): void

        • 引数

          • sender: this
          • オプション eventArgs: object

          戻り値 void

    戻り値 void

close

  • close(): void

  • 現在のGcTourを閉じます。

    戻り値 void

destroy

  • destroy(): void

  • 現在のコントロールを破棄します。

    戻り値 void

goTo

  • goTo(index: number): void

  • 指定されたインデックスのステップに移動します。

    引数

    • index: number

      対象ステップのインデックス。

    戻り値 void

next

  • next(): void

  • 次のステップに進みます。

    戻り値 void

previous

  • previous(): void

  • 前のステップに戻ります。

    戻り値 void

removeEventListener

  • removeEventListener(eventName: GcTourEvent, func?: (sender: this, eventArgs?: object): void): void

  • addEventListenerで登録したイベントを削除します。

    gcTour.removeEventListener(GC.InputMan.GcTourEvent.StepChanged, stepChangedHandler);

    引数

    • eventName: GcTourEvent

      イベントの種類を表す文字列（大文字と小文字を区別しません）

    • オプション func: (sender: this, eventArgs?: object): void

      コントロールから削除するイベント処理

        • (sender: this, eventArgs?: object): void

        • 引数

          • sender: this
          • オプション eventArgs: object

          戻り値 void

    戻り値 void

start

  • start(isContinue?: boolean): void

  • GcTourを開始します。

    引数

    • オプション isContinue: boolean

      前回停止位置から継続するかどうか。デフォルトはfalseです。

    戻り値 void

イベント

Closed

Closed: (sender: GcTour, args: TourClosedEventArgs): void

GcTour が閉じられたときに発生します。

param

イベントをトリガーしたGcTourオブジェクト。

param

イベントパラメータ

型宣言

StepChanged

StepChanged: (sender: GcTour, args: TourStepChangedEventArgs): void

ステップ切り替えが完了した後に発生します。

param

イベントをトリガーしたGcTourオブジェクト。

param

イベントパラメータ

型宣言

StepChanging

StepChanging: (sender: GcTour, args: TourStepChangingEventArgs): void

ステップ切り替え前に発生します。

param

イベントをトリガーしたGcTourオブジェクト。

param

イベントパラメータ

型宣言