@patternfly/react-charts
Version:
This library provides a set of React chart components for use with the PatternFly reference implementation.
108 lines • 4.22 kB
TypeScript
/// <reference types="react" />
import { PaddingProps, StringOrNumberOrCallback } from 'victory-core';
import { ChartThemeDefinition } from '../ChartTheme/ChartTheme';
/**
* ChartBulletGroupTitle renders a group title.
*/
export interface ChartBulletGroupTitleProps {
/**
* The ariaDesc prop specifies the description of the chart/SVG to assist with
* accessibility for screen readers.
*
* Note: Overridden by the desc prop of containerComponent
*/
ariaDesc?: string;
/**
* The ariaTitle prop specifies the title to be applied to the SVG to assist
* accessibility for screen readers.
*
* Note: Overridden by the title prop of containerComponent
*/
ariaTitle?: string;
/**
* 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 divider component to render with the chart
*/
dividerComponent?: React.ReactElement<any>;
/**
* The height props specifies the height the svg viewBox of the chart container.
* This value should be given as a number of pixels
*/
height?: number;
/**
* The name prop is typically used to reference a component instance when defining shared events. However, this
* optional prop may also be applied to child elements as an ID prefix. This is a workaround to ensure Victory
* based components output unique IDs when multiple charts appear in a page.
*/
name?: string;
/**
* The padding props specifies the amount of padding in number of pixels between
* the edge of the chart and any rendered child components. This prop can be given
* as a number or as an object with padding specified for top, bottom, left
* and right.
*
* Note: The bottom padding property is unused
*
* @propType number | { top: number, bottom: number, left: number, right: number }
*/
padding?: PaddingProps;
/**
* The standalone prop determines whether the component will render a standalone svg
* or a <g> tag that will be included in an external svg. Set standalone to false to
* compose ChartLine with other components within an enclosing <svg> tag.
*/
standalone?: boolean;
/**
* The subtitle to render for grouped bullets
*/
subTitle?: string;
/**
* The label component to render the chart subTitle.
*
* Note: Default label properties may be applied
*/
subTitleComponent?: React.ReactElement<any>;
/**
* The theme prop takes a style object with nested data, labels, and parent objects.
* You can create this object yourself, or you can use a theme provided by
* When using ChartLine as a solo component, implement the theme directly on
* ChartLine. If you are wrapping ChartLine in ChartChart or ChartGroup,
* please call the theme on the outermost wrapper component instead.
*
* @propType object
*/
theme?: ChartThemeDefinition;
/**
* Specifies the theme color. Valid values are 'blue', 'green', 'multi', etc.
*
* Note: Not compatible with theme prop
*
* @example themeColor={ChartThemeColor.blue}
*/
themeColor?: string;
/**
* The title to render for grouped bullets
*/
title?: string;
/**
* The label component to render the chart title.
*
* Note: Default label properties may be applied
*/
titleComponent?: React.ReactElement<any>;
/**
* The width props specifies the width of the svg viewBox of the chart container
* This value should be given as a number of pixels
*/
width?: number;
}
export declare const ChartBulletGroupTitle: React.FunctionComponent<ChartBulletGroupTitleProps>;
//# sourceMappingURL=ChartBulletGroupTitle.d.ts.map