@equinor/videx-wellog/dist/tracks/stack/interfaces.d.ts

Visualisation components for wellbore log data

import { TrackOptions } from '../interfaces';
interface StackedTrackOptions extends TrackOptions {
    /**
     * @brief Data for all plots in the track.
     *
     * May be of any type or a function or promise returning data.
     * The plots will need to have a data accessor function defined,
     * that can pick the data it needs from this value.
     */
    data?: Promise<any> | Function | any;
    /**
     * @brief Option to show labels on the track.
     */
    showLabels?: boolean;
    /**
     * @brief Option to show lines on the track.
     */
    showLines?: boolean;
    /** Option for the label logic. */
    labelOptions?: StackedTrackLabelOptions;
}
export interface StackedTrackLabelOptions {
    /**
     * @brief Rotation angle for the labels.
     *
     * The angle is computed clockwise from the track central line.
     * (i.e. The vertical line if the track is vertical and
     * the horizontal line if the track is horizontal.)
     */
    rotation: number;
    /** The ratio of width to use when determining font scale. Will be used if smaller than verticalScaleRatio. Default value is 0.5. */
    horizontalScaleRatio: number;
    /** The ratio of height to use when determining font scale. Will be used if smaller than horizontalScaleRatio. Default value is 0.1. */
    verticalScaleRatio: number;
}
interface TransformedAreaData {
    /**
     * Name of area, used in rendering label
     */
    name: string;
    /**
     * Start value for area
     */
    yFrom: number;
    /**
     * End value for area
     */
    yTo: number;
    /**
     * Fill color for area
     */
    color: string;
    /**
     * Opacity for area
     */
    opacity?: number;
}
interface AreaData {
    /**
     * Name of area, used in rendering label
     */
    name?: string;
    /**
     * Start value for area
     */
    from: number;
    /**
     * End value for area
     */
    to: number;
    /**
     * Fill color for area
     */
    color: {
        r: number;
        g: number;
        b: number;
        a?: number;
    };
}
export { StackedTrackOptions, TransformedAreaData, AreaData };