Class Capture

画面のキャプチャ機能を提供するクラス

Example

const capture = new Capture( viewer );
capture.setAttribution( options: CaptureOption );
const image1 = await capture.shoot();
const image2 = await capture.shoot();

Hierarchy

  • Capture

Constructors

constructor

Properties

_attribution_array? _attribution_bg_color _attribution_content _attribution_font_color _attribution_font_size _attribution_h_margin _attribution_h_spacing _attribution_height _attribution_v_margin _attribution_width _mime_type _sync _viewer

Methods

_addCaptureAttribution _addCaptureAttributionImg _addCaptureAttributionText _postRenderForCapture setAttributionBackgroundColor setAttributionContent setAttributionFontColor setAttributionFontSize setAttributionSize shoot

Constructors

constructor

Properties

Private Optional _attribution_array

_attribution_array?: Attribution[]

表示する著作権情報を管理するarray。 undefined の場合は、キャッシュが生成されていないことを表す

Private _attribution_bg_color

_attribution_bg_color: string

Private _attribution_content

_attribution_content: string[]

Private _attribution_font_color

_attribution_font_color: string

Private _attribution_font_size

_attribution_font_size: number

Private _attribution_h_margin

_attribution_h_margin: number

Private _attribution_h_spacing

_attribution_h_spacing: number

Private _attribution_height

_attribution_height: number

Private _attribution_v_margin

_attribution_v_margin: number

Private _attribution_width

_attribution_width: number

Private _mime_type

_mime_type: "image/png" | "image/jpeg"

Private _sync

_sync: boolean

Private _viewer

_viewer: Viewer

Methods

Private _addCaptureAttribution

  • _addCaptureAttribution(attribution_string: string, context: CanvasRenderingContext2D, attribution_array: Attribution[]): Promise<void>

  • キャプチャ画像用アノテーションを管理Arrayに追加(imgとtextを分離)

    Parameters

    • attribution_string: string
    • context: CanvasRenderingContext2D
    • attribution_array: Attribution[]

    Returns Promise<void>

Private _addCaptureAttributionImg

  • _addCaptureAttributionImg(img_tag: string, context: CanvasRenderingContext2D, attribution_array: Attribution[]): Promise<void>

  • キャプチャ画像用アノテーション(img)を管理Arrayに追加

    Parameters

    • img_tag: string
    • context: CanvasRenderingContext2D
    • attribution_array: Attribution[]

    Returns Promise<void>

Private _addCaptureAttributionText

  • _addCaptureAttributionText(text: string, context: CanvasRenderingContext2D, attribution_array: Attribution[]): Promise<void>

  • キャプチャ画像用アノテーション(text)を管理Arrayに追加

    Parameters

    • text: string
    • context: CanvasRenderingContext2D
    • attribution_array: Attribution[]

    Returns Promise<void>

Private _postRenderForCapture

  • _postRenderForCapture(context: CanvasRenderingContext2D): Promise<void>

  • キャプチャ画像にロゴやアノテーションを描画

    Parameters

    • context: CanvasRenderingContext2D

      書き込む2Dキャンバスコンテキスト

    Returns Promise<void>

setAttributionBackgroundColor

setAttributionContent

  • 著作権コンテナに表示する著作権を指定

    Example

    setAttribution([
            '<img src="./data/logo.png" width="30" height="16"/>attribution sample<img src="./data/logo.png" width="30" height="16">',
            '1234567890',
            '<img src="./data/mapray.svg" width="80" height="16" />',
    ])

    setAttribution( '1234567890<img src="./data/mapray.svg" width="80" height="16" />' );

    Parameters

    • attribution: string | string[]

    Returns void

setAttributionFontColor

setAttributionFontSize

setAttributionSize

shoot

Settings

Member Visibility

Theme