@patternfly/react-charts/dist/js/victory/components/ChartLabel/ChartLabel.d.ts

This library provides a set of React chart components for use with the PatternFly reference implementation.

/// <reference types="react" />
import { LabelOrientationType, OriginType, StringOrNumberOrCallback, TextAnchorType, VerticalAnchorType, VictoryLabelProps } from 'victory-core';
/**
 * ChartLabel renders the label components that are used across all Victory based components.
 *
 * See https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-label/victory-label.tsx
 */
export interface ChartLabelProps extends VictoryLabelProps {
    /**
     * The active prop specifies whether the label is active or not. The active prop is set by defaultEvents in components
     * like ChartTooltip and VictorySelectionContainer. The active prop is used when evaluating functional styles and
     * props.
     */
    active?: boolean;
    /**
     * Specifies the angle to rotate the text by.
     */
    angle?: string | number;
    /**
     * The capHeight prop defines a text metric for the font being used: the expected height of capital letters.
     * This is necessary because of SVG, which (a) positions the *bottom* of the text at `y`, and (b) has no notion of
     * line height. The value should ideally use the same units as `lineHeight` and `dy`, preferably ems. If given a
     * unitless number, it is assumed to be ems.
     *
     * @propType number | string | Function
     */
    capHeight?: StringOrNumberOrCallback;
    /**
     * The children of this component define the content of the label. This makes using the component similar to normal
     * HTML spans or labels. strings, numbers, and functions of data / value are supported.
     *
     * Note: This prop should not be set manually.
     *
     * @propType number | string | Function
     *
     * @private Not intended as public API and subject to change
     * @hide
     */
    children?: StringOrNumberOrCallback;
    /**
     * The className prop specifies a class name that will be applied to the rendered text element.
     */
    className?: string;
    /**
     * Labels that apply to an entire data series will receive the entire series as `data` instead of an individual datum
     * prop.
     */
    data?: any[];
    /**
     * Victory components can pass a datum prop to their label component. This can be used to calculate functional styles,
     * and determine child text
     */
    datum?: {};
    /**
     * The desc prop specifies the description of the chart/SVG to assist with accessibility for screen readers. The more
     * descriptive this title is, the more useful it will be for people using screen readers.
     */
    desc?: string;
    /**
     * The direction prop determines which text direction to apply to the rendered text element
     */
    direction?: 'rtl' | 'ltr' | 'inherit';
    /**
     * The dx prop defines a horizontal shift from the `x` coordinate.
     *
     * @propType number | string | Function
     */
    dx?: StringOrNumberOrCallback;
    /**
     * The dy prop defines a vertical shift from the `y` coordinate. Since this component already accounts for
     * `capHeight`, `lineHeight`, and `verticalAnchor`, this will usually not be necessary.
     *
     * @propType number | string | Function
     */
    dy?: StringOrNumberOrCallback;
    /**
     * The events prop attaches arbitrary event handlers to the label component.
     * Event handlers are currently only called with their corresponding events.
     */
    events?: React.DOMAttributes<any>;
    /**
     * The id prop specifies a HTML ID that will be applied to the rendered text element.
     */
    id?: StringOrNumberOrCallback;
    /**
     * The index prop represents the index of the datum in the data array.
     *
     * Note: This prop should not be set manually.
     *
     * @private Not intended as public API and subject to change
     * @hide
     */
    index?: string | number;
    /**
     * When the text property contains an array of strings, the inline property lets the <tspan /> elements lay out next
     * to each other. If this property is not specified, the <tspan /> elements will stack vertically instead.
     */
    inline?: boolean;
    /**
     * The labelPlacement prop is used to specify the placement of labels relative to the data point they represent.
     * This prop may be given as “vertical”, “parallel” or “perpendicular”. This props is particularly useful in polar
     * charts, where it may be desirable to position a label either parallel or perpendicular to its corresponding angle.
     * When this prop is not set, perpendicular label placement will be used for polar charts, and vertical label
     * placement will be used for cartesian charts.
     *
     * @propType string
     */
    labelPlacement?: LabelOrientationType;
    /**
     * The lineHeight prop defines how much space a single line of text should take up.
     * Note that SVG has no notion of line-height, so the positioning may differ slightly from what you would expect with CSS,
     * but the result is similar: a roughly equal amount of extra space is distributed above and below the line of text.
     * The value should ideally use the same units as `capHeight` and `dy`, preferably ems.
     * If given a unitless number, it is assumed to be ems.
     *
     * @propType number | string | Function
     */
    lineHeight?: StringOrNumberOrCallback;
    /**
     * Victory components will pass an origin prop is to define the center point in svg coordinates for polar charts.
     *
     * Note: It will not typically be necessary to set an origin prop manually
     *
     * @propType { x: number, y: number }
     */
    origin?: OriginType;
    /**
     * Victory components can pass a boolean polar prop to specify whether a label is part of a polar chart.
     *
     * Note: This prop should not be set manually.
     *
     * @private Not intended as public API and subject to change
     * @hide
     */
    polar?: boolean;
    /**
     * The renderInPortal prop specifies whether ChartLabel should render text in place or within a VictoryPortal.
     * Setting renderInPortal to true is equivalent to wrapping ChartLabel in a VictoryPortal. This prop is false by default.
     */
    renderInPortal?: boolean;
    /**
     * Victory components can pass a scale prop to their label component. This can be used to calculate the position of
     * label elements from datum.
     *
     * Note: This prop should not be set manually.
     *
     * @private Not intended as public API and subject to change
     * @hide
     */
    scale?: {
        x?: any;
        y?: any;
    };
    /**
     * The style prop applies CSS properties to the rendered `<text>` element.
     */
    style?: React.CSSProperties | React.CSSProperties[];
    /**
     * The text prop defines the text ChartLabel will render. The text prop may be given as a string, number, a function
     * of datum, or an array of any of these. Strings may include newline characters, which ChartLabel will split into
     * separate <tspan/> elements. When text is given as an array, separate <tspan/> elements will be created for each
     * element in the array.
     *
     * @propType number | string | Function | string[]
     */
    text?: string[] | StringOrNumberOrCallback;
    /**
     * The textAnchor prop defines how the text is horizontally positioned relative to the given `x` and `y` coordinates.
     * Options are "start", "middle" and "end". Note that this overrides the style prop.
     *
     * @propType string | Function
     */
    textAnchor?: TextAnchorType | (() => TextAnchorType);
    /**
     * The transform prop applies a transform to the rendered `<text>` element.
     * In addition to being a string, it can be an object containing transform definitions for easier authoring.
     */
    transform?: string | {} | (() => string | {});
    /**
     * The verticalAnchor prop defines how the text is vertically positioned relative to the given `x` and `y`
     * coordinates. Options are "start", "middle" and "end".
     *
     * @propType string
     */
    verticalAnchor?: VerticalAnchorType | (() => VerticalAnchorType);
    /**
     * This props refers to the width of the svg that VictoryLabel is rendered within. This prop is passed from parents
     * of VictoryLabel.
     *
     * Note: This prop should not be set manually.
     *
     * @private Not intended as public API and subject to change
     * @hide
     */
    width?: number;
    /**
     * The x prop defines the x coordinate to use as a basis for horizontal positioning.
     */
    x?: number;
    /**
     * The y prop defines the y coordinate to use as a basis for vertical positioning.
     */
    y?: number;
}
export declare const ChartLabel: React.FunctionComponent<ChartLabelProps>;
//# sourceMappingURL=ChartLabel.d.ts.map