@mikezimm/fps-library-v2
Version:
Library of reusable typescript/javascript functions, interfaces and constants
67 lines (66 loc) • 5.66 kB
JavaScript
/**
* CodeAnalizerComment: Updated 12 imports on 2024-09-22 14:49:52
* Update:: import { IRefinerRulesStrs } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesInts } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesNums } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesTime } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesUser } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesEXPE } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { IRefinerRulesNone } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { RefinerRulesStrs } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { RefinerRulesInts } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { RefinerRulesNums } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { RefinerRulesTime } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
* Update:: import { RefinerRulesUser } to '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners;'
*/
import * as React from 'react';
import { PivotItem, } from '@fluentui/react/lib/Pivot';
import { RefinerRulesStrs, RefinerRulesInts, RefinerRulesNums, RefinerRulesTime, RefinerRulesUser, } from '@mikezimm/fps-core-v7/lib/components/webparts/Drilldown/Refiners/IRefiners';
const padRight15 = { paddingRight: '15px' };
export function getHelpRefinerRules() {
const WebPartHelpElement = React.createElement(PivotItem, { headerText: 'Refiner Rules', itemIcon: 'Script' },
React.createElement("div", { className: 'fps-pph-content' },
React.createElement("div", { className: 'fps-pph-topic' }, "Rules are like calculated columns without the work - Only applies to refiners."),
React.createElement("div", null,
React.createElement("b", null, "Example:"),
" If you have a date column, actual dates or times are not good refiners because they typically will have to many values to choose from.",
React.createElement("br", null),
`However if you apply a rule like 'groupByYears', it will bucket all your items into years based on the values in the column.`,
React.createElement("br", null)),
React.createElement("div", null,
React.createElement("b", null, "NOTE:"),
` The web part only shows refiners based on the items it intially reads in. So in the case of 'groupByYears', `,
React.createElement("b", null, "you will not see a year if there are no items for that year"),
"."),
React.createElement("div", null,
React.createElement("b", null, "parseBy..."),
" will take a string column and create Refiners by splitting the string by commas and semi-colons."),
React.createElement("div", null,
React.createElement("b", null, "groupBy..."),
" will take number or date column values and group them into larger buckets."),
React.createElement("div", null,
"Generally speaking, use ",
React.createElement("b", null, "groupByString"),
" for ",
React.createElement("b", null, "Date columns"),
", espeically if you are using a string filter such as '/YYYY-MM'."),
React.createElement("div", null, "Generally speaking, only select one per refiner."),
React.createElement("div", { style: { display: 'flex' } },
React.createElement("div", { style: padRight15 },
React.createElement("div", { className: 'fps-pph-topic' }, "Number rules"),
React.createElement("ul", null, RefinerRulesNums.map((rule, idx) => React.createElement("li", { key: idx }, rule)))),
React.createElement("div", { style: padRight15 },
React.createElement("div", { className: 'fps-pph-topic' }, "Integer rules"),
React.createElement("ul", null, RefinerRulesInts.map((rule, idx) => React.createElement("li", { key: idx }, rule)))),
React.createElement("div", { style: padRight15 },
React.createElement("div", { className: 'fps-pph-topic' }, "String rules"),
React.createElement("ul", null, RefinerRulesStrs.map((rule, idx) => React.createElement("li", { key: idx }, rule)))),
React.createElement("div", { style: padRight15 },
React.createElement("div", { className: 'fps-pph-topic' }, "Time rules"),
React.createElement("ul", null, RefinerRulesTime.map((rule, idx) => React.createElement("li", { key: idx }, rule)))),
React.createElement("div", { style: padRight15 },
React.createElement("div", { className: 'fps-pph-topic' }, "User rules"),
React.createElement("ul", null, RefinerRulesUser.map((rule, idx) => React.createElement("li", { key: idx }, rule)))))));
return WebPartHelpElement;
}
//# sourceMappingURL=RefinerRules.js.map