Version 6.4.0.0.beta1, tag libreoffice-6.4.0.0.beta1
[LibreOffice.git] / odk / examples / DevelopersGuide / Spreadsheet / DataPilotReadme.txt
blob7876b6a339a48f3568180622c77cbf83712ed3b6
2 # This file is part of the LibreOffice project.
4 # This Source Code Form is subject to the terms of the Mozilla Public
5 # License, v. 2.0. If a copy of the MPL was not distributed with this
6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 # This file incorporates work covered by the following license notice:
10 #   Licensed to the Apache Software Foundation (ASF) under one or more
11 #   contributor license agreements. See the NOTICE file distributed
12 #   with this work for additional information regarding copyright
13 #   ownership. The ASF licenses this file to you under the Apache
14 #   License, Version 2.0 (the "License"); you may not use this file
15 #   except in compliance with the License. You may obtain a copy of
16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
19 ExampleDataPilotSource
20 ======================
22 This example shows how you can implement an external DataPilot
23 component.
25 Simple usage scenario:
26 ======================
27 1. build and deploy the component
28 2. open a new spreadsheet document
29 3. select for example cell B:2
30 4. start the DataPilot dialog
31    Data->DataPilot->Start...
32 5. select "External source/interface -> Ok
33 6. select the example DataPilot
34    Use the drop down list and select the service
35    "ExampleDataPilotSource" -> Ok
36 7. Place some number fields in the field areas
37    For example:
38    - select the "ones" field and drop it in the "Row Fields" area
39    - repeat this step with the "tens" and "hundreds" field
40    - select the "thousands" field and drop it in the "Column Fields"
41      area.
42    -> press Ok
43 8. you see a matrix with rows and columns for the selected fields
44    and a value area with a sum up of all fields valid for this
45    coordinate. For example cell F:21=1221 (ones=B:21=1, tens=c:21=2
46    hundreds=D:21=2 and thousands=F:3=1)