describeProfile
describeProfile(
profile,unit?):string
Defined in: packages/core/src/describe.ts:15
A plain-language summary of what a profile shows, for a screen reader or a caption: the total, the largest categories of the arranging dimension with their counts, which dimension each visual property shows when they differ, and how many items each mark stands for. Every number in it is one the legends also show. A view’s layout that carries these fields can be passed as it is.
Parameters
Section titled “Parameters”profile
Section titled “profile”Pick<Profile, "encoding" | "legends" | "itemsPerMark" | "itemCount">
string = "items"
Returns
Section titled “Returns”string