BaseScatterLayer

BaseScatterLayer (クラス)

            public abstract BaseScatterLayer
            {inherits StackableChartLayer}

パッケージ： CURL.GUI.CHARTS

直接継承しているサブクラス: BubbleLayer, ScatterLayer

すべてのタイプの散布図で必要な機能の大部分を定義する抽象 ChartLayer サブクラス。これは、ScatterLayer および BubbleLayer のスーパークラスです。

説明

散布図は、ScatterLayer でも BubbleLayer でも、各データポイントに Shape を置くことによって機能する図です。BaseScatterLayer.scatter-shape によって使用される形状を定義できます。そうしないと、連続した各データ系列は新しい形状を使用します。

次の非ローカルオプションは、特に BaseScatterLayer に関連しています。

次の非ローカルオプションは ScatterLayer と関連があります。

scatter-shape-size

以下の非ローカルオプションは BubbleLayer と関連があります。

注意事項

グラフへのその他のオブジェクトの追加については、ChartLayer を参照してください。

例

ScatterLayer または BubbleLayer を参照してください。

コンストラクタ

default:

新しい BaseScatterLayer を初期化します。

コンストラクタ public

{BaseScatterLayer.default

x-axis-data:#ChartDataSeries = null,
stacking-mode:ChartStackingMode = ChartStackingMode.none,
scatter-shape:any = null,
border-color:any = FillPattern.black,
...

}

プロパティ

scatter-border-line-style:

BaseScatterLayer 内で生成された Shape に適用される LineStyle。

非ローカルオプション public BaseScatterLayer.scatter-border-line-style:LineStyle

scatter-border-width:

BaseScatterLayer 内に生成される Shape に適用される境界幅。

非ローカルオプション public BaseScatterLayer.scatter-border-width:any

scatter-shape:

各データポイントに生成される Shape オブジェクトの外観を制御します。

アクセサ public BaseScatterLayer.scatter-shape:any

セッター public BaseScatterLayer.scatter-shape:any

series-shapes:

この ScatterLayer のプロットを表す Shape を含む配列。

フィールド public constant BaseScatterLayer.series-shapes:{Array-of Shape} ={new {Array-of Shape}}

プロパティ継承 StackableChartLayer: generate-y-axes?, stacking-mode

プロパティ継承 ChartLayer: chart, color-associations, legend-enabled?, legend-entry-factory, style-element, x-axis-data, y-axis-data

プロパティ継承 Shape: as-Shape, border-color, color, draw-operation, option-parent, selection-context, shape-parent, shape-selectable, stroke-thickness, transformation, visible?

プロパティ継承 ShapeContainerBase: as-ShapeRoot, shape-children

プロパティ継承 DataBindingTarget: data-binding-context, data-bindings

プロパティ継承 EventTarget: event-handlers

プロパティ継承 OptionListInterface: option-register-proc, registered-option-keys

クラス変数と定数

ShapeFactory:

BaseScatterLayer Shape 要素の生成に使用されるファクトリープロシージャの Type。これは、BaseScatterLayer.scatter-shape オプションに設定できる型の 1 つです。

public constant BaseScatterLayer.ShapeFactory:ProcType ={proc-type {layer:BaseScatterLayer, series:ChartDataSeries, series-index:int, record:Record, record-index:int, shape:ScatterShape, position:Distance2d, scatter-shape-x-size:Distance, scatter-shape-y-size:Distance, border-width:any, border-line-style:LineStyle, fill-pattern-for-series:FillPattern }:Shape }

クラスプロシージャ

default-shape-factory:

BaseScatterLayer のプロット Shape を生成するために使用される既定ファクトリ。

public

{BaseScatterLayer.default-shape-factory

layer:BaseScatterLayer,
series:ChartDataSeries,
series-index:int,
record:Record,
record-index:int,
shape:ScatterShape,
position:Distance2d,
x-size:Distance,
y-size:Distance,
border-width:any,
border-line-style:LineStyle,
fill-pattern-for-series:FillPattern

}:Shape

generate-stock-shape:

ScatterShape のメンバの 1 つを Shape として生成します。

public

{BaseScatterLayer.generate-stock-shape

parent:#Shape,
shape:ScatterShape,
position:Distance2d,
x-size:Distance,
y-size:Distance,
border-width:any,
border-line-style:LineStyle,
fill-pattern:FillPattern

}:Shape

メソッド

get-data-series-from-shape:

Shape に関連した ChartDataSeries を決定します (ある場合)。

public

{BaseScatterLayer.get-data-series-from-shape

shape:Shape

}:#ChartDataSeries

get-size-for-datum:

指定の Record をプロットする場合のサイズを決定します。

protected abstract

{BaseScatterLayer.get-size-for-datum

series:ChartDataSeries,
series-index:int,
record:Record,
record-index:int

}:(x-size:Distance, y-size:Distance)

set-data-series-visibility:

ChartLayer.y-axis-data の個々のメンバの表示を制御します。

public

{BaseScatterLayer.set-data-series-visibility

data-series-index:int,
visible?:bool

}:void

update-layout:

この ChartLayer の内部レイアウトを更新します。

public

{BaseScatterLayer.update-layout}:void

メソッド継承 StackableChartLayer: append-data-series, compute-data-min-max, get-data-mapping, get-inverse-data-mapping

メソッド継承 Shape: apply-rotation, apply-scale, apply-transformation, apply-translation, apply-translation-in-parent, constrain-own-layout-bounds, constrain-shape-layout-bounds, contains-point?, find-graphical-ancestor, fire-crossing-event, fire-in-child, get-display-context, get-down-orientation-in-shape-parent, get-graphical-root, get-local-device-pixel-size, get-origin-in-graphical-ancestor, get-origin-in-root, get-origin-in-shape-parent, get-origin-in-shape-root, get-own-bounds-in-shape-root, get-own-layout-bounds, get-right-orientation-in-shape-parent, get-shape-bounds, get-shape-bounds-in-shape-root, get-shape-layout-bounds, get-top-left-in-ancestor, get-transformation-to-shape-root, keyword-init-arg, option-change-notify, overdraw-for-selection, quantize-line-thickness, request-draw, request-draw-self, reset-transformation, set-rotation, set-scale, set-transformation, set-translation-in-parent, to-Graphic, transform-from-display-coordinates, transform-from-graphical-root-coordinates, transform-point-from-shape-root, transform-point-to-shape-root, transform-to-display-coordinates, transform-to-graphical-root-coordinates, transform-vector-from-shape-root, transform-vector-to-shape-root, transformation-changed, transformation-changing

メソッド継承 Observer: observe, stop-observing

メソッド継承 GraphicOptions: any-to-Distance

メソッド継承 GuiEventTarget: handle-event, on-action, on-cancel-mode, on-command-changed, on-commit, on-composition-change-event, on-composition-result-event, on-context-menu-event, on-current-record-change-request, on-current-record-changed, on-destroy-notify, on-destroy-requested, on-drag-over, on-drag-pointer, on-drag-started, on-drop, on-end-composition-event, on-focus-event, on-focus-in, on-focus-out, on-grab-release, on-gui-event, on-input-method-event, on-inspection, on-key-event, on-key-press, on-pointer-button, on-pointer-crossing, on-pointer-event, on-pointer-motion, on-pointer-press, on-pointer-release, on-pointer-scroll, on-raw-key-event, on-raw-key-press, on-raw-key-release, on-reset, on-selectable-added, on-selectable-removed, on-selection-changed, on-selection-context-activated, on-selection-context-deactivated, on-selection-event, on-start-composition-event, on-start-event, on-stop-event, on-view-activate, on-view-deactivate, on-window-close, remove-event-handlers-for-event-class

メソッド継承 DataBindingTarget: add-data-binding, get-data-binding, refresh-data-binding, remove-data-binding, unset-property, update-data-binding, validate-data-binding

メソッド継承 EventTarget: accepts-event-class?, add-event-handler, event-handler-present?, remove-event-handler, verify-event

メソッド継承 BasicEventTarget: enqueue-event

メソッド継承 InitRestArgParser: process-rest-args

メソッド継承 Object: object-describe, object-describe-for-debugging, object-serialize

コンストラクタ詳細

default (コンストラクタ)

public

{BaseScatterLayer.default

x-axis-data:#ChartDataSeries = null,
stacking-mode:ChartStackingMode = ChartStackingMode.none,
scatter-shape:any = null,
border-color:any = FillPattern.black,
...

}

新しい BaseScatterLayer を初期化します。

x-axis-data: ChartLayer.default を参照してください。

stacking-mode: StackableChartLayer.default を参照してください。

scatter-shape: BaseScatterLayer.scatter-shape の初期値。null の既定値の結果、使用される ScatterShape が自動的に決定されます。

border-color: この ChartLayer での Shape.border-color オプションの初期値。

...: ChartLayer.default を参照してください。

プロパティ詳細

scatter-border-line-style (非ローカルオプション)

public BaseScatterLayer.scatter-border-line-style:LineStyle

BaseScatterLayer 内で生成された Shape に適用される LineStyle。

説明

scatter-border-line-style を参照してください。

scatter-border-width (非ローカルオプション)

public BaseScatterLayer.scatter-border-width:any

BaseScatterLayer 内に生成される Shape に適用される境界幅。

説明

scatter-border-width を参照してください。

scatter-shape (アクセサ)

アクセサ public BaseScatterLayer.scatter-shape:any

セッター public BaseScatterLayer.scatter-shape:any

各データポイントに生成される Shape オブジェクトの外観を制御します。

説明

このプロパティは、次のタイプにすることができます。

Type	Description
null	既定値の null は、ScatterShape が選択されるので、BaseScatterLayer.y-axis-data の各メンバが異なるものを取得することを意味します。
ScatterShape	この列挙体の要素を使用する場合、その要素は使用される形状となります。各形状の例については、該当するドキュメントを参照してください。
BaseScatterLayer.ShapeFactory	このタイプのファクトリープロシージャを指定できます。たとえば、これは BarLayer.shape-factory と同様に機能します。このプロシージャは、各データポイントで 1 回呼び出され、このレイヤに追加される Shape を返します。次の例はこのことを示しています。BaseScatterLayer.default-shape-factory および BaseScatterLayer.generate-stock-shape も参照してください。後者のプロシージャは、異なるコンテキストでグラフにこの種の形状を生成したい場合に、BaseScatterLayer の外部での呼び出しにも適しています。

例

この例では、テキストオブジェクトを使用して、最初を除くすべての系列のデータを表すファクトリープロシージャを提供します。最初の系列の場合、BaseScatterLayer.default-shape-factory の呼び出しを示します。

下の scatter-shape の定義をコメントアウトして、既定の動作を確認してください。

例: ファクトリーとしての BaseScatterLayer.scatter-shape の使用

{import * from CURL.GUI.CHARTS}
{import * from CHARTS-DOC,
    location = "../docstring-support/gui/charts-doc.scurl"
}

{LayeredChart
    width = 15cm,
    height = 6cm,
    {ScatterLayer
        sample-records,
        "Age",
        "Points",
        x-axis-data = {ChartDataSeries sample-records, "Name"},
        scatter-shape =
            {proc {layer:BaseScatterLayer,
                   series:ChartDataSeries,
                   series-index:int,
                   record:Record,
                   record-index:int,
                   shape:ScatterShape,
                   position:Distance2d,
                   scatter-shape-x-size:Distance,
                   scatter-shape-y-size:Distance,
                   border-width:any,
                   border-line-style:LineStyle,
                   fill-pattern-for-series:FillPattern
                  }:Shape
                
                {return
                    {if series-index == 0 then
                        || First data series uses standard method:
                        {BaseScatterLayer.default-shape-factory
                            layer,
                            series,
                            series-index,
                            record,
                            record-index,
                            shape,
                            position,
                            scatter-shape-x-size,
                            scatter-shape-y-size,
                            border-width,
                            border-line-style,
                            fill-pattern-for-series
                        }
                     else
                        || Use a text label.
                        {TextShape
                            {series.field.domain.format
                                record[series.field.name]
                            },
                            translation = position,
                            color = fill-pattern-for-series
                        }
                    }
                }
            }
    }
}

series-shapes (フィールド)

public constant BaseScatterLayer.series-shapes:{Array-of Shape} ={new {Array-of Shape}}

この ScatterLayer のプロットを表す Shape を含む配列。

説明

この配列には、BaseScatterLayer.y-axis-data 内の ChartDataSeries ごとに 1 つの要素が格納されます。これらの Shapes は、BaseScatterLayer.scatter-shape に基づいて作成されたオブジェクトを子として持ちます。このプロパティは、Shape が生成される方法を変更するために使用できます。

この配列は、単なるインスペクション用で、変更はできません。要素の順序を変更したり、要素を追加または削除したりしないでください。また、その内容は、グラフのレイアウト処理が行われるたびに変更されます。そのため、レイアウト処理が行われて初めてその内容が有効になります。EventHandler を ChartLayoutChanged に対して使用し、これらの値が変更された時点で通知を受け取ることができます。

この配列内の Shape オブジェクトの変更は許可されます。ただし、一般的に BaseScatterLayer.scatter-shape にファクトリープロシージャを提供して同じことを行うほうがはるかに容易です。レイアウトが変更された時点や形状の更新が必要となる時点を考慮する必要がないので、この手法をお勧めします。

クラス変数と定数の詳細

ShapeFactory (クラス定数)

BaseScatterLayer Shape 要素の生成に使用されるファクトリープロシージャの Type。これは、BaseScatterLayer.scatter-shape オプションに設定できる型の 1 つです。

layer: Shape 生成が実行される BaseScatterLayer。

series: プロットされる ChartDataSeries。

series-index: series が見つかる BaseScatterLayer.y-axis-data へのインデックス。

record: ShapeFactory のこの特定の呼び出しに対応する Record。

record-index: RecordSet の先頭からカウントした record のインデックス。

shape: 作成される形状を記述する ScatterShape。

position: record に対応する Distance2d。これは、record および record-index について map.get-position から取得したものと同じ値です。

scatter-shape-x-size: 形状を生成するときに使用される水平方向サイズ。ScatterLayer の場合、この値は ScatterLayer.scatter-shape-size から取得されます。BubbleLayer の場合、これは計算された値となります。

scatter-shape-y-size: 形状を生成するときに使用される垂直サイズ。ScatterLayer の場合、この値は ScatterLayer.scatter-shape-size から取得されます。BubbleLayer の場合、これは計算された値となります。

border-width: Shape の生成で使用される境界幅。この値は、scatter-border-width から取得されます。

border-line-style: Shape の生成で使用される境界 LineStyle。この値は、scatter-border-line-style から取得されます。

fill-pattern-for-series: 作成される Shape が入れられる FillPattern。

戻り値

BaseScatterLayer に追加される Shape。返された値は、BaseScatterLayer.series-shapes のメンバの 1 つの子になります。

説明

このタイプの詳細およびその使用例については、BaseScatterLayer.scatter-shape を参照してください。

クラスプロシージャ詳細

default-shape-factory (クラスプロシージャ)

public

{BaseScatterLayer.default-shape-factory

}:Shape

BaseScatterLayer のプロット Shape を生成するために使用される既定ファクトリ。

layer: Shape 生成が実行される BaseScatterLayer。

series: プロットされる ChartDataSeries。

series-index: series が見つかる BaseScatterLayer.y-axis-data へのインデックス。

record: ShapeFactory のこの特定の呼び出しに対応する Record。

record-index: RecordSet の先頭からカウントした record のインデックス。

shape: 作成される形状を記述する ScatterShape。

position: record に対応する Distance2d。これは、record および record-index について map.get-position から取得したものと同じ値です。

border-width: Shape の生成で使用される境界幅。この値は、scatter-border-width から取得されます。

border-line-style: Shape の生成で使用される境界 LineStyle。この値は、scatter-border-line-style から取得されます。

border-width: Shape の生成で使用される境界幅。この値は、scatter-border-width から取得されます。

戻り値

BaseScatterLayer に追加できる Shape。

説明

このプロシージャは、BaseScatterLayer.generate-stock-shape を使用して、適切な形状を作成します。このプロシージャは、独自のファクトリープロシージャ内から呼び出すのが一般的です。たとえば、Tooltip または他のプロパティを追加することにより、結果を変更できます。BaseScatterLayer.default-shape-factory を呼び出すファクトリープロシージャの例については、BaseScatterLayer.scatter-shape を参照してください。

generate-stock-shape (クラスプロシージャ)

public

{BaseScatterLayer.generate-stock-shape

parent:#Shape,
shape:ScatterShape,
position:Distance2d,
x-size:Distance,
y-size:Distance,
border-width:any,
border-line-style:LineStyle,
fill-pattern:FillPattern

}:Shape

ScatterShape のメンバの 1 つを Shape として生成します。

parent: このオブジェクトの親となる Shape (ある場合)。このパラメータは、ピクセルサイズの見積もりにのみ使用されます。生成された shape は、このプロシージャではこれに加えられることはありません。このパラメータが null である場合、プライマリディスプレイのピクセルサイズが使用されます。

position: Shape を配置する位置を記述する Distance2d。

x-size: 作成される Shape の水平方向サイズ。

y-size: 作成される Shape の垂直方向サイズ。

border-width: 生成された Shape に適用される境界幅（該当する場合）。(例については、RectangleShape.border-width を参照してください。)

border-line-style: 生成された Shape に適用される LineStyle (該当する場合)。(例については、RectangleShape.border-line-style を参照してください。)

fill-pattern: 生成された Shape に適用するために使用される FillPattern。

戻り値

要求された Shape。

説明

このメソッドは BaseScatterLayer.default-shape-factory と似ていますが、ファクトリープロシージャの外部にアクセスできない引数を必要としないので、より幅広い環境設定で呼び出すのに適しています。

例

例: グラフの外部での BaseScatterLayer.generate-stock-shape の使用

{import * from CURL.GUI.CHARTS}
{import * from CHARTS-DOC,
    location = "../docstring-support/gui/charts-doc.scurl"
}

{BaseScatterLayer.generate-stock-shape
    null,
    ScatterShape.star,
    {Distance2d .5cm, .5cm},
    1cm,
    1cm,
    1px,
    LineStyle.solid,
    FillPattern.navy
}

メソッド詳細

get-data-series-from-shape (メソッド)

public

{BaseScatterLayer.get-data-series-from-shape

shape:Shape

}:#ChartDataSeries

Shape に関連した ChartDataSeries を決定します (ある場合)。

shape: 検索する Shape。

説明

ChartLayer.y-axis-data の要素を表すために、Shape がこの ChartLayer によって生成された場合は、このメソッドでその要素が判別され、該当するデータ系列が返されます。その他の場合は、null を返します。

ChartLayer をサブクラス化しようとする場合は、このメソッドを実装する必要があります。これは通常、生成された Shape のセットを追跡し、渡される Shape が既知の Shape のメンバであるかどうかを決定することにより実行されます。

get-size-for-datum (メソッド)

protected abstract

{BaseScatterLayer.get-size-for-datum

series:ChartDataSeries,
series-index:int,
record:Record,
record-index:int

}:(x-size:Distance, y-size:Distance)

指定の Record をプロットする場合のサイズを決定します。

series: 考慮される ChartDataSeries。

series-index: series が見つかる BaseScatterLayer.y-axis-data へのインデックス。

record: 考慮される Record。

record-index: 組み込む側の RecordSet 内の record のインデックス。

戻り値

それぞれ X 次元と Y 次元のサイズを表す 2 つの Distance。

説明

このメソッドは、BaseScatterLayer 内の内部プロットロジックによって呼び出されてから、BaseScatterLayer.default-shape-factory を呼び出すことによって、あるいはファクトリープロシージャが BaseScatterLayer.scatter-shape に設定されていれば、そのファクトリープロシージャを呼び出すことによって、実際に形状を生成します。

このメソッドは、対応するロジックを実装するために、ScatterLayer と BubbleLayer の両方によってオーバーライドされます。このメソッドは内部的に呼び出されるだけですが、独自のロジックを提供するようにオーバーライドできます。

set-data-series-visibility (メソッド)

public

{BaseScatterLayer.set-data-series-visibility

data-series-index:int,
visible?:bool

}:void

ChartLayer.y-axis-data の個々のメンバの表示を制御します。

data-series-index: 変更するデータ系列で、ChartLayer.y-axis-data へのインデックスとして表わされます。

visible?: data-series-index によって参照されるデータ系列が表示されない場合は、false です。

説明

これは、凡例メンバや既存の系列の色を変更せずにデータの可視性を制御する場合に役立ちます。この実装は ChartLayer サブクラスによって実行されます。標準グラフレイヤは Shape.visible? を使用して可視性を制御します。独自のサブクラス内でこのメソッドを実装する場合、必ずスーパークラスの実装を呼び出す必要があります。

例

例: ChartLayer.set-data-series-visibility の使用

{import * from CURL.GUI.CHARTS}
{import * from CHARTS-DOC,
    location = "../docstring-support/gui/charts-doc.scurl"
}

{let chart:LayeredChart =
    {LayeredChart
        width = 12cm,
        height = 6cm,
        {LineLayer
            sample-records,
            "Age",
            "Points",
            "Height",
            x-axis-data = {ChartDataSeries sample-records, "Name"},
            symbols-at-data-points? = true
        }
    }
}

{value chart}

{CheckButton
    label = "Show Age?",
    value = true,
    {on ValueFinished at cb:CheckButton do
        let layer:ChartLayer = chart.layers[0]
        {layer.set-data-series-visibility 0, cb.value}
    }
}

{CheckButton
    label = "Show Points?",
    value = true,
    {on ValueFinished at cb:CheckButton do
        let layer:ChartLayer = chart.layers[0]
        {layer.set-data-series-visibility 1, cb.value}
    }
}

{CheckButton
    label = "Show Height?",
    value = true,
    {on ValueFinished at cb:CheckButton do
        let layer:ChartLayer = chart.layers[0]
        {layer.set-data-series-visibility 2, cb.value}
    }
}

update-layout (メソッド)

public

{BaseScatterLayer.update-layout}:void

この ChartLayer の内部レイアウトを更新します。

説明

これは LayeredChart.update-layout から呼び出されます。ChartLayer の実装では、このメソッドを使用して、プロット形状が再生成され、レイヤに追加されます。ChartLayer をサブクラス化しようとする場合、データを表すためにさまざまな Shape を作成し、ChartLayer.add を使用してレイヤに追加するためには、このメソッドをオーバーライドする必要があります。