Class AttributionController

著作権表示の表示制御

Hierarchy

ContainerController
- AttributionController

Constructors

constructor

new AttributionController(options?: mapray.AttributionController.Option): AttributionController
コンストラクタ
Parameters
- options: mapray.AttributionController.Option = {}
  
  表示オプション（任意で著作権コンテナの表示に関するオプションを指定する。）
Returns AttributionController
Overrides ContainerController.constructor
- Defined in packages/mapray/src/AttributionController.ts:30

Properties

`Private` _attributions

_attributions: string[]

`Private` _background_color

_background_color: Vector4

`Protected` _container

_container: HTMLElement

`Private` _default_attributions

_default_attributions: string[]

`Protected` _is_compact

_is_compact: boolean

`Private` _normalize_attribution_styles

_normalize_attribution_styles: boolean

`Protected` _position

_position: mapray.ContainerController.ContainerPosition

`Protected` _sub_container

_sub_container: HTMLElement

`Private` _text_color

_text_color: Vector3

`Protected` `Optional` _viewer

_viewer?: Viewer

`Protected` _visibility

_visibility: boolean

Methods

`Private` _addAttribution

_addAttribution(attribution: string | string[], is_default: boolean): void
指定した著作権をコンテナに追加
Parameters
- attribution: string | string[]
  
  単体もしくは配列の文字列 ( HTMLタグ可 )
- is_default: boolean
  
  デフォルト要素として追加するか
Returns void
- Defined in packages/mapray/src/AttributionController.ts:84

`Private` _addDomNodeForAttribution

_addDomNodeForAttribution(attribution: string, is_default: boolean): void
コンテナに著作権を追加

追加した著作権はコンテナに表示されている著作権の末尾に配置される。
Parameters
- attribution: string
  
  著作権
- is_default: boolean
Returns void
- Defined in packages/mapray/src/AttributionController.ts:264

`Private` _clearDefaultAttribution

_clearDefaultAttribution(): void
コンテナが持つデフォルトの著作権をリセット

Returns void
- Defined in packages/mapray/src/AttributionController.ts:162

`Private` _getDefaultAttributions

_getDefaultAttributions(): string[]
コンテナが持つデフォルトの著作権を取得

Returns
デフォルトの著作権配列

Returns string[]
- Defined in packages/mapray/src/AttributionController.ts:177

`Private` _isValidAttribution

_isValidAttribution(attribution: string): boolean
著作権を追加する際に、コンテナに既にある著作権と重複していないかを確認

Returns
重複していないなら true、重複しているなら false
Parameters
- attribution: string
  
  確認する対象の著作権
Returns boolean
- Defined in packages/mapray/src/AttributionController.ts:242

`Private` _removeDefaultAttribution

_removeDefaultAttribution(attribution: string): void
指定した著作権をコンテナが持つデフォルトの著作権から削除
Parameters
- attribution: string
  
  対象の著作権を示す文字列
Returns void
- Defined in packages/mapray/src/AttributionController.ts:149

`Protected` _sizeChanged

_sizeChanged(): void
リサイズイベント

Returns void
Inherited from ContainerController._sizeChanged
- Defined in packages/mapray/src/ContainerController.ts:187

`Private` _updateBackgroundColor

_updateBackgroundColor(): void
コンテナの背景色の変更処理

Returns void
- Defined in packages/mapray/src/AttributionController.ts:288

`Private` _updateTextColor

_updateTextColor(): void
Returns void
- Defined in packages/mapray/src/AttributionController.ts:294

addAttribution

addAttribution(attribution: string | string[]): void
指定した著作権をコンテナに追加
Parameters
- attribution: string | string[]
  
  単体もしくは配列の文字列 ( HTMLタグ可 )
Returns void
- Defined in packages/mapray/src/AttributionController.ts:73

clearAttribution

clearAttribution(): void
コンテナが持つ著作権をリセット

「©Mapray」を含むデフォルトの著作権はリセットしない。

Returns void
- Defined in packages/mapray/src/AttributionController.ts:124

getAttributions

getAttributions(): string[]
コンテナが持つ著作権を取得

Returns
著作権の配列

Returns string[]
- Defined in packages/mapray/src/AttributionController.ts:139

getBackgroundColor

getBackgroundColor(): Vector4
コンテナの現在の背景色を取得

Returns
GeoMath で表される色情報

Returns Vector4
- Defined in packages/mapray/src/AttributionController.ts:208

getCompact

getCompact(): boolean
コンテナの表示設定を取得

Returns
コンテナのコンパクト状態

Returns boolean
Inherited from ContainerController.getCompact
- Defined in packages/mapray/src/ContainerController.ts:135

getPositon

getPositon(): mapray.ContainerController.ContainerPosition
コンテナの表示位置を取得

Returns
ContainerController.ContainerPosition で定義されるコンテナの表示位置

Returns mapray.ContainerController.ContainerPosition
Inherited from ContainerController.getPositon
- Defined in packages/mapray/src/ContainerController.ts:110

getTextColor

getTextColor(): Vector3
コンテナの現在の文字色を取得

Returns
GeoMath で表される色情報

Returns Vector3
- Defined in packages/mapray/src/AttributionController.ts:231

getVisibility

getVisibility(): boolean
コンテナの表示状態を取得

Returns
コンテナの表示状態 ( 真偽値 )

Returns boolean
Inherited from ContainerController.getVisibility
- Defined in packages/mapray/src/ContainerController.ts:76

removeAttribution

removeAttribution(attribution: string): void
指定した著作権をコンテナから削除
Parameters
- attribution: string
  
  対象の著作権を示す文字列
Returns void
- Defined in packages/mapray/src/AttributionController.ts:109

setBackgroundColor

setBackgroundColor(color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]): void
コンテナの背景色を変更
Parameters
- color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]
  
  GeoMath で表される色情報
Returns void
- Defined in packages/mapray/src/AttributionController.ts:187

setCompact

setCompact(compact: boolean): void
コンテナの表示設定を変更

画面横サイズが一定値より小さい場合はこれに関係なく、コンパクト表示となる。
Parameters
- compact: boolean
  
  コンテナをコンパクトにするかを決定する真偽値
Returns void
Inherited from ContainerController.setCompact
- Defined in packages/mapray/src/ContainerController.ts:122

setPosition

setPosition(position: mapray.ContainerController.ContainerPosition): void
表示位置の変更
Parameters
- position: mapray.ContainerController.ContainerPosition
  
  ContainerController.ContainerPosition で定義される値
Returns void
Inherited from ContainerController.setPosition
- Defined in packages/mapray/src/ContainerController.ts:86

setTextColor

setTextColor(color: Vector3): void
コンテナの文字色を変更
Parameters
- color: Vector3
  
  GeoMath で表される色情報
Returns void
- Defined in packages/mapray/src/AttributionController.ts:218

setVisibility

setVisibility(visibility: boolean): void
コンテナの表示・非表示の切り替え
Parameters
- visibility: boolean
  
  真偽値 ( true で表示、false で非表示 )
Returns void
Inherited from ContainerController.setVisibility
- Defined in packages/mapray/src/ContainerController.ts:62

Class AttributionController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: mapray.AttributionController.Option = {}

Returns AttributionController

Properties

Private _attributions

Private _background_color

Protected _container

Private _default_attributions

Protected _is_compact

Private _normalize_attribution_styles

Protected _position

Protected _sub_container

Private _text_color

Protected Optional _viewer

Protected _visibility

Methods

Private _addAttribution

Parameters

attribution: string | string[]

is_default: boolean

Returns void

Private _addDomNodeForAttribution

Parameters

attribution: string

is_default: boolean

Returns void

Private _clearDefaultAttribution

Returns void

Private _getDefaultAttributions

Returns

Returns string[]

Private _isValidAttribution

Returns

Parameters

attribution: string

Returns boolean

Private _removeDefaultAttribution

Parameters

attribution: string

Returns void

Protected _sizeChanged

Returns void

Private _updateBackgroundColor

Returns void

Private _updateTextColor

Returns void

addAttribution

Parameters

attribution: string | string[]

Returns void

clearAttribution

Returns void

getAttributions

Returns

Returns string[]

getBackgroundColor

Returns

Returns Vector4

getCompact

Returns

Returns boolean

getPositon

Returns

Returns mapray.ContainerController.ContainerPosition

getTextColor

Returns

Returns Vector3

getVisibility

Returns

Returns boolean

removeAttribution

Parameters

`Private` _attributions

`Private` _background_color

`Protected` _container

`Private` _default_attributions

`Protected` _is_compact

`Private` _normalize_attribution_styles

`Protected` _position

`Protected` _sub_container

`Private` _text_color

`Protected` `Optional` _viewer

`Protected` _visibility

`Private` _addAttribution

`Private` _addDomNodeForAttribution

`Private` _clearDefaultAttribution

`Private` _getDefaultAttributions

`Private` _isValidAttribution

`Private` _removeDefaultAttribution

`Protected` _sizeChanged

`Private` _updateBackgroundColor

`Private` _updateTextColor