NumericAxis-of

{NumericAxis-of t:NumericType} (クラス)

            public NumericAxis-of
            {inherits {NumericAxisMixin-of t}, ChartAxis}

パッケージ： CURL.GUI.CHARTS

明示的な範囲に基づく ChartAxis の数値実装。

説明

ほとんどの軸タイプとは対象的に、このクラスはその基礎としてデータを使用しません。代わりに、t によって指定された Type および作成時に (または NumericAxis-of.set-range を介して) 明示的に指定された範囲を使用します。

注意事項

NumericDataSeriesAxis-of と異なり、NumericAxis-of.default コンストラクタに対する force-zero? パラメータは既定で false となります。これは、範囲が既に明示的に指定されているので、通常は必要ないためです。

例

例: NumericAxis-of を使用しての固定範囲軸の指定

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

{LayeredChart
    width = 15cm,
    height = 6cm,
    left-axis = {new {NumericAxis-of double}, 0, 70},
    {BarLayer
        {ChartDataSeries sample-records, "Age"},
        {ChartDataSeries sample-records, "Points"},
        {ChartDataSeries sample-records, "Wins"},
        x-axis-data = {ChartDataSeries sample-records, "Name"}
    }
}

コンストラクタ

default:

新しい NumericAxis-of を作成します。

コンストラクタ public

{NumericAxis-of.default

minimum:t,
maximum:t,
force-zero?:bool = false,
force-range?:bool = false,
force-range-strict?:bool = false,
forced-min:t = {unit-value-for-type t},
forced-max:t = {unit-value-for-type t},
visible-values:{Array-of t} = {new {Array-of t}},
label-group:ChartLabelGroup = {ChartLabelGroup},
axis-group:Shape = {ShapeGroup},
axis-line-group:Shape = {ShapeGroup},
major-tick-group:Shape = {ShapeGroup},
minor-tick-group:Shape = {ShapeGroup},
...

}

プロパティ

maximum:

この軸の最大値。

フィールド public-get private-set NumericAxis-of.maximum:t

maximum-displayed-t:

この軸で表示される実際の最大値。

フィールド public-get private-set NumericAxis-of.maximum-displayed-t:t

minimum:

この軸の最小値。

フィールド public-get private-set NumericAxis-of.minimum:t

minimum-displayed-t:

この軸で表示される実際の最小値。

フィールド public-get private-set NumericAxis-of.minimum-displayed-t:t

tick-count:

この軸で表示される目盛りの実際の数。

フィールド public-get private-set NumericAxis-of.tick-count:int

プロパティ継承 NumericAxisMixin-of: force-range-strict?, force-range?, forced-max, forced-min, tick-spacing-proc, visible-values

プロパティ継承 ChartAxis: axis-group, axis-label, axis-line-group, chart, label-group, length, major-tick-factory, major-tick-group, minor-tick-factory, minor-tick-group, position, style-element, tick-label-factory, x-axis?, y-axis?

プロパティ継承 ShapeGroup: clonable-class?

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

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

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

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

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

メソッド

generate-axis-label:

この ChartAxis に適切な軸ラベルを生成します。

public

{NumericAxis-of.generate-axis-label}:#Shape

generate-major-ticks:

この軸に沿った主目盛りを表すのに必要なすべての Shape を生成します。

protected

{NumericAxis-of.generate-major-ticks}:void

generate-minor-ticks:

この軸に沿った補助目盛りを表すのに必要なすべての Shape を生成します。

protected

{NumericAxis-of.generate-minor-ticks}:void

get-data-type:

ChartAxis の定義方法を記述します。

public

{NumericAxis-of.get-data-type}:(type:AxisDataType, value:any)

get-position-at-zero:

この軸に沿ったゼロに対応する空間位置を取得します。

public

{NumericAxis-of.get-position-at-zero}:Distance

get-relative-position:

データ値に対応する空間位置を計算します。

public

{NumericAxis-of.get-relative-position val:any}:Fraction

get-value-relative:

この軸に沿った位置に対応するデータ値を計算します。

public

{NumericAxis-of.get-value-relative position:Fraction}:any

note-visible-values-changed:

この軸に NumericAxisMixin-of.visible-values の内容が変更されたことを通知します。

public

{NumericAxis-of.note-visible-values-changed}:void

set-forced-range:

NumericAxisMixin-of.calculate-tick-spacing でこの軸が使用する境界に制約を適用します (またはその制約を削除します)。

public

{NumericAxis-of.set-forced-range

force-range?:bool,
force-range-strict?:bool = false,
forced-min:t = {unit-value-for-type t},
forced-max:t = {unit-value-for-type t}

}:void

set-range:

この軸の範囲を設定します。

public

{NumericAxis-of.set-range minimum:t, maximum:t}:void

メソッド継承 NumericAxisMixin-of: calculate-tick-spacing, generate-numeric-ticks

メソッド継承 ChartAxis: clear-shapes, detach, generate-axis-line, generate-major-tick, generate-minor-tick, generate-tick-label, get-axis-label, get-major-ticks-Iterator, get-minor-ticks-Iterator, get-position, get-tick-label, get-tick-label-alignment, get-value, note-min-max-computation-changed, regenerate-shapes, transform-from-chart, transform-to-chart, update-layout

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

メソッド継承 ShapeGroup: clone-appearance-helper, draw, get-own-bounds, get-own-bounds-in-shape-root, self-contains-point?, self-intersects-polygon?

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

メソッド継承 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-gui-path, get-gui-path-to-child, 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-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

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

メソッド継承 GuiEventTarget: handle-delegate-event, 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-gesture, on-gesture-begin, on-gesture-end, on-gesture-magnify, on-gesture-pan, on-gesture-rotate, on-gesture-swipe, on-gesture-tap, on-gesture-touch, 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

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

メソッド継承 BasicEventTarget: enqueue-event

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

コンストラクタ詳細

default (コンストラクタ)

public

{NumericAxis-of.default

}

新しい NumericAxis-of を作成します。

minimum: このグラフの初期最小値。NumericAxis-of.minimum を参照してください。

maximum: このグラフの初期最大値。NumericAxis-of.maximum を参照してください。

force-zero?: true の場合、この軸の最小値と最大値は、ゼロが表現されるように必要に応じて調整されます。(この機能は、visible-values にゼロを追加することによって実装されます。)

force-range?: true の場合、forced-min および forced-max がこの軸の境界を設定するために使用されます。

force-range-strict?: true の場合、forced-min および forced-max は、変更なしにこの軸の境界となります。そうでない場合は、最も近い概数値に調整されます。

forced-min: force-range? が true の場合にこの軸の最小値として使用される値。

forced-max: force-range? が true の場合にこの軸の最大値として使用される値。

visible-values: この軸の境界内に常に含まれる値の配列。NumericAxisMixin-of.visible-values を参照してください。

label-group: ChartAxis.label-group の初期値。

axis-group: ChartAxis.axis-group の初期値。

axis-line-group: ChartAxis.axis-line-group の初期値。

major-tick-group: ChartAxis.major-tick-group の初期値。

minor-tick-group: ChartAxis.minor-tick-group の初期値。

...: Shape が受け取る引数のいずれか。これらは主に、オプションの初期化を表すキーワード引数です。

例

NumericAxis-of を参照してください。

プロパティ詳細

maximum (フィールド)

public-get private-set NumericAxis-of.maximum:t

この軸の最大値。

説明

この値は、NumericAxis-of.default コンストラクタまたは NumericAxis-of.set-range メソッドによって設定できます。

注意事項

NumericAxisMixin-of.force-range-strict? が true でない限り、直接この値が表示される最大値になるという保証はありません。通常、この値以上の概数が使用されます。このプロセスを制御するアルゴリズムについては、NumericAxisMixin-of.calculate-tick-spacing を参照してください。

maximum-displayed-t (フィールド)

public-get private-set NumericAxis-of.maximum-displayed-t:t

この軸で表示される実際の最大値。

説明

この値は、レイアウト処理の過程で NumericAxis-of.generate-major-ticks 内で計算されます。したがって、これが有効で、意味を持つのは、レイアウト処理が完了したグラフ内にこの軸が含まれる場合だけです。(Chart.ensure-layout-valid を参照してください。)

minimum (フィールド)

public-get private-set NumericAxis-of.minimum:t

この軸の最小値。

説明

この値は、NumericAxis-of.default コンストラクタまたは NumericAxis-of.set-range メソッドによって設定できます。

注意事項

NumericAxisMixin-of.force-range-strict? が true でない限り、直接この値が表示される最小値になるという保証はありません。通常、この値以下の概数が使用されます。このプロセスを制御するアルゴリズムについては、NumericAxisMixin-of.calculate-tick-spacing を参照してください。

minimum-displayed-t (フィールド)

public-get private-set NumericAxis-of.minimum-displayed-t:t

この軸で表示される実際の最小値。

説明

tick-count (フィールド)

public-get private-set NumericAxis-of.tick-count:int

この軸で表示される目盛りの実際の数。

説明

メソッド詳細

generate-axis-label (メソッド)

public

{NumericAxis-of.generate-axis-label}:#Shape

この ChartAxis に適切な軸ラベルを生成します。

戻り値

ラベルを表す Shape、または null (ラベルを表示しない場合)。

説明

ChartAxis サブクラスはこのメソッドを定義する必要があります。既存の ChartAxis クラスをサブクラス化しようとする場合、このメソッドをオーバーライドすることもできます。軸ラベルの外観の制御については、ChartAxis.get-axis-label を参照してください。

作成される Shape は位置決めの必要がありません。ChartLabelGroup が、適宜その位置を軸の位置に合わせて直接に設定するからです。この位置に関するオフセットを指定したい場合、ラベル形状に必要な変換を適用して、それを ShapeGroup 内に組み込むことができます。ShapeGroup は、ChartLabelGroup で位置付けられるオブジェクトになり、組み込んだ子 Shape は、これと共に配置されます。スケーリングを使用した場合にこれを示す例については、axis-label を参照してください。

生成されたオブジェクトがその原点に対して適切に位置付けられることに注意する必要があります。原点は、軸の中央に沿って、軸自体の近くに配置され、オブジェクトの回転角度は、水平軸、垂直軸それぞれで 0 度、 -90 度になります。こうした理由で、生成した形状が意図した位置になるように (たとえば、軸および目盛りが重ならないように)、その形状を注意して位置付ける必要があります。

TextShape などのオブジェクトに関する halign や horiginなどのオプションを使用して、このことを確実にする方法については、axis-label を参照してください。

注意事項

これは通常、軸を制御するデータに依存するように実装されます。たとえば、DataSeriesAxis およびサブクラスは、そこに含まれるすべての RecordField の RecordField.caption 値を含む TextShape が返します。

generate-major-ticks (メソッド)

protected

{NumericAxis-of.generate-major-ticks}:void

この軸に沿った主目盛りを表すのに必要なすべての Shape を生成します。

説明

これは、ChartAxis の実装で、生成する目盛りの数、目盛りを配置する場所、およびその方法を明らかにして、実際に実行するメソッドです。このメソッドは、ChartAxis.update-layout から呼び出されることを想定しています。

このメソッドを実装する場合は、ChartAxis.generate-major-tick を使用して、標準の目盛り形状を作成すると便利です。生成された Shape は、ChartAxis.major-tick-group に追加されます。

generate-minor-ticks (メソッド)

protected

{NumericAxis-of.generate-minor-ticks}:void

この軸に沿った補助目盛りを表すのに必要なすべての Shape を生成します。

説明

これは、ChartAxis.generate-major-ticks に対応する補助目盛りです。標準軸を実装しても補助目盛りは生成されないので、ChartAxis.generate-minor-ticks は何も実行しません。このメソッドは、ChartAxis.update-layout から呼び出されることを想定しています。

このメソッドを実装しようとする場合は、ChartAxis.generate-minor-tick を使用して、標準の目盛り形状を作成すると便利です。生成された Shape は、ChartAxis.minor-tick-group に追加されます。

get-data-type (メソッド)

public

{NumericAxis-of.get-data-type}:(type:AxisDataType, value:any)

ChartAxis の定義方法を記述します。

戻り値

この軸に関連するデータまたはメトリックを記述する AxisDataType およびそのメトリックを記述する値。

説明

このメソッドは、軸とデータを一致させる LayeredChart システムによって使用されます。たとえば、この軸が ChartDataSeries と直接関連付けられている場合は、これを該当するデータ系列のプロットに関連付けるのは適切です。そのため、このメソッドでは、軸内で使用されたデータ系列と一緒に AxisDataType.data-series が返されます。

次の表では、可能なそれぞれの AxisDataType について返されることが想定される値の型について説明しています。

AxisDataType	value	記述の種類
AxisDataType.data-series	{Array-of ChartDataSeries}	この軸は 1 つ以上の ChartDataSeries に直接関連付けられ、その系列は返される配列に含まれます。すべてのデータ系列は同じ Domain オブジェクトを共有する必要があります。(これは、最も一般的に使用される軸のタイプです。)
AxisDataType.record-field	{Array-of RecordField}	この軸は、1 つ以上の RecordField に直接関連付けられます。すべてのフィールドは、同じ Domain を共有する必要があります。同じフィールドを使用していれば、データは軸に一致します。使用された RecordField が配列に返されます。
AxisDataType.field-name	{Array-of String}	AxisDataType.record-field と非常によく似た方法で、この軸は、名前によってレコードの 1 つ以上のレコードフィールドと関連付けられます。同じ名前のフィールドを使用していれば、データはこの軸に一致します。使用されたフィールド名が配列に返されます。
AxisDataType.type	Type	軸は、一定の Type を計測するものとして自身を定義します。NumericAxis-of は、このタイプの軸の例です。よりよい一致がないと、同じタイプを使用するデータがこの軸と比較されます。
AxisDataType.record-index	なし (null)	この軸は、データを無視して、Record を順に配置します。このタイプの軸は、X 軸にのみ適しています。どのデータとも比較されますが、優先度が最も低い一致の種類です。DefaultChartAxis および DefaultBarChartAxis はこの種の軸の例です。

get-position-at-zero (メソッド)

public

{NumericAxis-of.get-position-at-zero}:Distance

この軸に沿ったゼロに対応する空間位置を取得します。

説明

これにより、値は ChartAxis.get-position と同じ動作を持つこの軸の長さと共に返されます。詳細については、該当のメソッドを参照してください。

注意事項

ゼロの概念は、すべての軸で意味を持つわけではありません。具体的には、GenericDataSeriesAxis および EnumeratedBarChartAxis は序数軸であって、連続値ベースの軸でないので、ゼロの概念は適用しません。こうした軸では常に 0m が返されます。

get-relative-position (メソッド)

public

{NumericAxis-of.get-relative-position val:any}:Fraction

データ値に対応する空間位置を計算します。

value: 軸の種類によって、必要な型が異なる値。ChartAxis.get-position を参照してください。互換性のない型を渡すとエラーが発生します。

戻り値

軸に沿ったデータ値の位置を示す Fraction。軸の原点の 0 から、軸の終点の 1 までです。

説明

これは基本的に、軸の方向または長さの概念がない ChartAxis.get-position と同じです。実際、このメソッドはこの意味で実装されます。詳細については、ChartAxis.get-position を参照してください。

get-value-relative (メソッド)

public

{NumericAxis-of.get-value-relative position:Fraction}:any

この軸に沿った位置に対応するデータ値を計算します。

position: この軸に沿った位置 (分数として)。これは、0 と 1 の間にある必要があります。

戻り値

この軸に適切な型の値。各種の軸に適切な値の Type については、ChartAxis.get-position を参照してください。

説明

これは基本的に、軸の方向または長さの概念がない ChartAxis.get-value と同じです。実際、このメソッドはこの意味で実装されます。詳細については、ChartAxis.get-value を参照してください。

note-visible-values-changed (メソッド)

public

{NumericAxis-of.note-visible-values-changed}:void

この軸に NumericAxisMixin-of.visible-values の内容が変更されたことを通知します。

説明

軸で必要なレイアウト操作を実行できるようにするために、NumericAxisMixin-of.visible-values の内容を変更する場合には、必ずこのメソッドを呼び出す必要があります。

set-forced-range (メソッド)

public

{NumericAxis-of.set-forced-range

force-range?:bool,
force-range-strict?:bool = false,
forced-min:t = {unit-value-for-type t},
forced-max:t = {unit-value-for-type t}

}:void

NumericAxisMixin-of.calculate-tick-spacing でこの軸が使用する境界に制約を適用します (またはその制約を削除します)。

force-range?: true の場合、この軸に表示される範囲は、このメソッドの他のパラメータによって決定されます。そうでない場合、その範囲はデータからの最小値と最大値に基づいており、このメソッドに対する他のパラメータは無視されます。

forced-min: force-range? が true の場合にこの軸の最小値として使用される値。

forced-max: force-range? が true の場合にこの軸の最大値として使用される値。

説明

このメソッドを使用して、この軸で表示されるデータ境界を制御できます。通常、NumericAxisMixin-of.calculate-tick-spacing は、データ内にある最小値と最大値で決定された境界で始まります。ただし、force-range? を true として指定すると、データの最小値と最大値ではなく、forced-min と forced-max が使用されます。

通常、この最小値と最大値のソースに関係なく、NumericAxisMixin-of.calculate-tick-spacing が最適な目盛り間隔を決定し、境界をこの間隔の最も近い倍数値に切り上げます。ただし、force-range-strict? が true であると、forced-min と forced-max は、切り上げなしに常にそのまま使用されます。

強制範囲の有効性には関係なく、NumericAxisMixin-of.visible-values が適用されることに注意してください。

注意事項

これらの値は、NumericAxisMixin-of.default コンストラクタから、または NumericDataSeriesAxis-of.default コンストラクタと NumericAxis-of.default コンストラクタから初期化することもできます。

例

例: 次の使用: NumericAxisMixin-of.set-forced-range

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

{let constant axis:{NumericDataSeriesAxis-of double} =
    {new {NumericDataSeriesAxis-of double},
        {ChartDataSeries sample-records, "Age"},
        {ChartDataSeries sample-records, "Points"},
        force-zero? = false,
        force-range? = true,
        force-range-strict? = false,
        forced-min = 1.5,
        forced-max = 7.5
    }
}

{LayeredChart
    width = 15cm,
    height = 7cm,
    left-axis = axis,
    {LineLayer
        sample-records,
        "Age",
        "Points",
        x-axis-data =
            {ChartDataSeries sample-records, "Name"}
    }
}

{Table
    columns = 2,
    {text forced-min:},
    {TextField
        value = "" & axis.forced-min,
        {on ValueFinished at tf:TextField do
            {axis.set-forced-range
                axis.force-range?,
                force-range-strict? = axis.force-range-strict?,
                forced-min = {tf.value.to-double},
                forced-max = axis.forced-max
            }
        }
    },
    {text forced-max:},
    {TextField
        value = "" & axis.forced-max,
        {on ValueFinished at tf:TextField do
            {axis.set-forced-range
                axis.force-range?,
                force-range-strict? = axis.force-range-strict?,
                forced-min = axis.forced-min,
                forced-max = {tf.value.to-double}
            }
        }
    }
}

{CheckButton
    label = "force-range?",
    value = axis.force-range?,
    {on ValueFinished at cb:CheckButton do
        {axis.set-forced-range
            cb.value,
            force-range-strict? = axis.force-range-strict?,
            forced-min = axis.forced-min,
            forced-max = axis.forced-max
        }
    }
}

{CheckButton
    label = "force-range-strict?",
    value = axis.force-range-strict?,
    {on ValueFinished at cb:CheckButton do
        {axis.set-forced-range
            axis.force-range?,
            force-range-strict? = cb.value,
            forced-min = axis.forced-min,
            forced-max = axis.forced-max
        }
    }
}

set-range (メソッド)

public

{NumericAxis-of.set-range minimum:t, maximum:t}:void

この軸の範囲を設定します。

minimum: この軸の最小値。

maximum: この軸の最大値。

説明

このメソッドでは、NumericAxis-of.minimum および NumericAxis-of.maximum が設定されます。NumericAxisMixin-of.force-range-strict? が true でない限り、これらの値が直接表示される最小値と最大値になるという保証はありません。通常、これらは、最も近い概数に切り上げられます。このプロセスを制御するアルゴリズムについては、NumericAxisMixin-of.calculate-tick-spacing を参照してください。