Class DataSourcePivotTable

DataSourcePivotTable

मौजूदा डेटा सोर्स की पिवट टेबल को ऐक्सेस करें और उसमें बदलाव करें. डेटा सोर्स का नया पिवट टेबल बनाने के लिए, Range.createDataSourcePivotTable(dataSource) का इस्तेमाल करें.

इस क्लास का इस्तेमाल सिर्फ़ ऐसे डेटा के साथ करें जो डेटाबेस से कनेक्ट हो.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addColumnGroup(columnName)PivotGroupडेटा सोर्स में दिए गए कॉलम के आधार पर, एक नया पिवट कॉलम ग्रुप जोड़ता है.
addFilter(columnName, filterCriteria)PivotFilterइससे, तय किए गए डेटा सोर्स कॉलम के आधार पर, फ़िल्टर की तय शर्तों के साथ एक नया फ़िल्टर जोड़ा जाता है.
addPivotValue(columnName, summarizeFunction)PivotValueखास जानकारी देने वाले फ़ंक्शन के साथ, बताए गए डेटा सोर्स कॉलम के आधार पर नई पिवट वैल्यू जोड़ता है.
addRowGroup(columnName)PivotGroupदिए गए डेटा सोर्स के कॉलम के आधार पर, एक नया पिवट पंक्ति ग्रुप जोड़ता है.
asPivotTable()PivotTableडेटा सोर्स की पिवट टेबल को सामान्य पिवट टेबल ऑब्जेक्ट के तौर पर दिखाता है.
cancelDataRefresh()DataSourcePivotTableअगर इस ऑब्जेक्ट का डेटा अभी चालू है, तो इससे जुड़ा डेटा रीफ़्रेश होना रद्द हो जाता है.
forceRefreshData()DataSourcePivotTableइस ऑब्जेक्ट के डेटा को रीफ़्रेश करता है, भले ही मौजूदा स्थिति कुछ भी हो.
getDataSource()DataSourceउस डेटा सोर्स को फ़ेच करता है जिससे ऑब्जेक्ट लिंक किया गया है.
getStatus()DataExecutionStatusऑब्जेक्ट के डेटा एक्ज़ीक्यूशन की स्थिति की जानकारी देता है.
refreshData()DataSourcePivotTableऑब्जेक्ट का डेटा रीफ़्रेश करता है.
waitForCompletion(timeoutInSeconds)DataExecutionStatusमौजूदा निष्पादन पूरा होने तक इंतज़ार करता है, दिए गए सेकंड के बाद टाइम आउट हो जाता है.

ज़्यादा जानकारी वाला दस्तावेज़

addColumnGroup(columnName)

डेटा सोर्स में दिए गए कॉलम के आधार पर, एक नया पिवट कॉलम ग्रुप जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringपिवट ग्रुप के लिए, डेटा सोर्स कॉलम का नाम जिस पर आधारित है.

रिटर्न

PivotGroup — नया पिवट ग्रुप.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addFilter(columnName, filterCriteria)

इससे, तय किए गए डेटा सोर्स कॉलम के आधार पर, फ़िल्टर की तय शर्तों के साथ एक नया फ़िल्टर जोड़ा जाता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringडेटा सोर्स के कॉलम का नाम, जिस पर फ़िल्टर आधारित है.
filterCriteriaFilterCriteriaफ़िल्टर किन शर्तों का इस्तेमाल करता है.

रिटर्न

PivotFilter — नया फ़िल्टर.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addPivotValue(columnName, summarizeFunction)

खास जानकारी देने वाले फ़ंक्शन के साथ, बताए गए डेटा सोर्स कॉलम के आधार पर नई पिवट वैल्यू जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringपिवट वैल्यू के आधार पर, डेटा सोर्स कॉलम का नाम.
summarizeFunctionPivotTableSummarizeFunctionपिवट वैल्यू का इस्तेमाल करने वाला 'खास जानकारी' फ़ंक्शन.

रिटर्न

PivotValue — नई पिवट वैल्यू.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addRowGroup(columnName)

दिए गए डेटा सोर्स के कॉलम के आधार पर, एक नया पिवट पंक्ति ग्रुप जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringपिवट ग्रुप के लिए, डेटा सोर्स कॉलम का नाम जिस पर आधारित है.

रिटर्न

PivotGroup — नया पिवट ग्रुप.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asPivotTable()

डेटा सोर्स की पिवट टेबल को सामान्य पिवट टेबल ऑब्जेक्ट के तौर पर दिखाता है.

रिटर्न

PivotTable — पिवट टेबल.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

अगर इस ऑब्जेक्ट का डेटा अभी चालू है, तो इससे जुड़ा डेटा रीफ़्रेश होना रद्द हो जाता है.

इस उदाहरण में, फ़ॉर्मूला रीफ़्रेश को रद्द करने का तरीका बताया गया है.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourcePivotTable — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

इस ऑब्जेक्ट के डेटा को रीफ़्रेश करता है, भले ही मौजूदा स्थिति कुछ भी हो. ज़्यादा जानकारी के लिए, refreshData() पर जाएं. अगर आपको इस ऑब्जेक्ट के अभी चल रहे रीफ़्रेश को रद्द करना है, तो cancelDataRefresh() देखें.

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourcePivotTable — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

उस डेटा सोर्स को फ़ेच करता है जिससे ऑब्जेक्ट लिंक किया गया है.

रिटर्न

DataSource — डेटा सोर्स.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

ऑब्जेक्ट के डेटा एक्ज़ीक्यूशन की स्थिति की जानकारी देता है.

रिटर्न

DataExecutionStatus — डेटा प्रोसेस होने का स्टेटस.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

ऑब्जेक्ट का डेटा रीफ़्रेश करता है.

अगर वर्तमान में error स्थिति में है, तो अपवाद फेंकता है. खास जानकारी को अपडेट करने के लिए, DataSource#updateSpec() का इस्तेमाल करें. डेटा सोर्स में अनचाहे बदलावों को रोकने के लिए, इस तरीके को forceRefreshData() पर प्राथमिकता दी जाती है.

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourcePivotTable — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

मौजूदा निष्पादन पूरा होने तक इंतज़ार करता है, दिए गए सेकंड के बाद टाइम आउट हो जाता है. अगर टाइम आउट पर एक्ज़ीक्यूशन पूरा नहीं होता है, तो अपवाद दिखाता है, लेकिन डेटा एक्ज़ीक्यूशन की प्रोसेस को रद्द नहीं करता.

पैरामीटर

नामटाइपब्यौरा
timeoutInSecondsIntegerडेटा प्रोसेस होने तक इंतज़ार करने का समय (सेकंड में). यह अवधि ज़्यादा से ज़्यादा 300 सेकंड हो सकती है.

रिटर्न

DataExecutionStatus — डेटा प्रोसेस होने का स्टेटस.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets