victory-core
Version:
91 lines • 4.09 kB
TypeScript
/**
* Returns a getDomain function
* @param {Function} getDomainFromDataFunction: a function that takes props and axis and
* returns a domain based on data
* @param {Function} formatDomainFunction: a function that takes domain, props, and axis and
* returns a formatted domain
* @returns {Function} a function that takes props and axis and returns a formatted domain
*/
export declare function createDomainFunction(getDomainFromDataFunction?: any, formatDomainFunction?: any): (props: any, axis: any) => any;
/**
* Returns a formatted domain.
* @param {Array} domain: a domain in the form of a two element array
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Array} a domain in the form of a two element array
*/
export declare function formatDomain(domain: any, props: any, axis: any): any;
/**
* Returns a domain for a given axis based on props, category, or data
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Array} the domain for the given axis
*/
export declare function getDomain(props: any, axis: any): any;
/**
* Returns a domain based on categories if they exist
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @param {Array} categories: an array of categories corresponding to a given axis
* @returns {Array|undefined} returns a domain from categories or undefined
*/
export declare function getDomainFromCategories(props: any, axis: any, categories?: any): any[] | undefined;
/**
* Returns a domain from a dataset for a given axis
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @param {Array} dataset: an array of data
* @returns {Array} the domain based on data
*/
export declare function getDomainFromData(props: any, axis: any, dataset: any): any[] | undefined;
/**
* Returns a domain in the form of a two element array given a min and max value.
* @param {Number|Date} min: the props object
* @param {Number|Date} max: the current axis
* @returns {Array} the minDomain based on props
*/
export declare function getDomainFromMinMax(min: any, max: any): any[];
/**
* Returns a the domain for a given axis if domain is given in props
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Array|undefined} the domain based on props
*/
export declare function getDomainFromProps(props: any, axis: any): any;
/**
* Returns a domain for a given axis. This method forces the domain to include
* zero unless the domain is explicitly specified in props.
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Array} the domain for the given axis
*/
export declare function getDomainWithZero(props: any, axis: any): any;
/**
* Returns the maxDomain from props if it exists
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Number|Date|undefined} the maxDomain based on props
*/
export declare function getMaxFromProps(props: any, axis: any): any;
/**
* Returns the minDomain from props if it exists
* @param {Object} props: the props object
* @param {String} axis: the current axis
* @returns {Number|Date|undefined} the minDomain based on props
*/
export declare function getMinFromProps(props: any, axis: any): any;
/**
* Returns a symmetrically padded domain for polar charts
* @param {Array} domain: the original domain
* @param {Array} values: a flat array of values corresponding to either tickValues, or data values
* for a given dimension i.e. only x values.
* @returns {Array} the symmetric domain
*/
export declare function getSymmetricDomain(domain: any, values: number[]): any[];
/**
* Checks whether a given component can be used to calculate domain
* @param {Component} component: a React component instance
* @returns {Boolean} Returns true if the given component has a role included in the whitelist
*/
export declare function isDomainComponent(component: any): boolean;
//# sourceMappingURL=domain.d.ts.map